Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Acly committed May 22, 2016
1 parent 29f5e43 commit b3a4337
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 8 deletions.
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,23 @@

GUI which displays HDR images, no bullshit.

![Screenshots](/media/Screenshots.png?raw=true)

## Features

* Opens popular HDR image formats: Radiance PIC (_*.pic, *.hdr_), PFM (_*.pfm, *.ppm_), OpenEXR (_*.exr_)
* Exports images in Radiance PIC or PFM format
* Fast zoom, pan and brightness control
* Manage multiple documents in tabs
* Manage multiple image documents in tabs
* Compare opened images (absolute difference or side-by-side)

## Build

* Install Qt 5.5
* Download [boost](http://www.boost.org/) (headers are sufficient, no need to build)
* Clone the repository from `https://github.com/Acly/hdrv.git`

### Windows
### Windows - VC14
```
mkdir build
cd build
Expand All @@ -25,7 +28,7 @@ qmake -tp vc ../hdrv.pro "BOOST_ROOT=/path/to/boost"
This generates a project file which can be used to build the application with Visual Studio.
After building, runtime libraries can be copied with `windeployqt --qmldir ../src/view release/hdrv.exe`.

Tested using Visual Studio 2015 Update 1 x64.
Tested using Visual Studio 2015 Update 2 x64.

### Other Platforms

Expand All @@ -39,12 +42,26 @@ Entirely untested, but there is no platform-dependent code or anything else any

## Use

It's a self-explanatory and intuitive GUI. Duh.
Load images by supplying them as arguments to the hdrv executable, drag-and-drop them into the viewer or
use the _Open image_ button in the tab bar.

### Mouse controls

* \[ **Pan** \] Hold the left mouse button to view different regions of the image if it does not fit on the screen.
* \[ **Zoom** \] Use the mouse wheel to scale the image.
* \[ **Compare** \] Hold the right mouse button in comparison mode to move the image comparison separator.

### Keybaord shortcuts

* \[ **+**/**-** \] Increase / decrease the image brightness.
* \[ **Left**/**Right** \] Iterate through images in the current folder.
* \[ **1**/**2**/**3**/... \] Switch to image tab 1, 2, 3, ...
* \[ **S** \] Toggle between the last two image tabs.
* \[ **C** \] Open comparison mode for the last two images.
* \[ **R** \] Reset positioning and scaling of the image.

## TODO

* Show current pixel location and color under cursor
* Show more stats (average / maximum / minimum color)
* Better tone mapping
* Hight quality tone mapping
* Better support for existing formats (encodings, layouts)
* Image comparison tools
Binary file added media/Screenshots.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/view/Main.qml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ApplicationWindow {
height: 800
visible: true
color: 'black'
title: images.current.name + ' - hdrv 0.2'
title: images.current.name + ' - hdrv 0.3'

function loadNextFile(prev) {
var url = images.nextFile(prev);
Expand Down

0 comments on commit b3a4337

Please sign in to comment.