PhotographicTonemapData Class Reference
Detailed Description
Data container for photographic tonemap.
#include <PhotographicTonemapData.h>
Public Member Functions |
|
| PhotographicTonemapData (void) | |
| Default constructor. |
|
| PhotographicTonemapData (const PhotographicTonemapData &source) | |
| Copy constructor. |
|
| bool | IsValid (void) const |
| Check if parameters are valid. |
|
| bool | operator== (const PhotographicTonemapData &source) const |
| Comparison operator. |
|
| bool | operator!= (const PhotographicTonemapData &source) const |
| Comparison operator. |
|
Public Attributes |
|
| bool | active |
| Data state State can be true or false if the
tonemap data should be used or not. |
|
| float | shutterSpeed |
| Shutter Speed in seconds. |
|
| float | aperture |
| Aperture in f/[aperture]. |
|
| float | filmSpeed |
| ISO film speed. |
|
| float | highlights |
| Increase the brightness of the highlights.
|
|
| float | midtones |
| Affects the Midtones of the image. |
|
| float | shadows |
| Increases the depth of the shadows in the
image. |
|
| float | colorSaturation |
| Saturates or desaturates the colors of the
rendering. |
|
| bool | useWhitePointColor |
| Specifies whether to color or the
temperature parameter should be used to set the white point.
|
|
| float | whitePoint |
| Specifies the white point of your scene
(white balance). |
|
| float | whitePointColor [3] |
| Specifies the white point of your scene
(white balance) using a rgb color. |
|
| float | vignetting |
| Reduces the image brightness in the image
periphery compared to the image center. |
|
| float | gamma |
| Adjusts intensity curve. |
|
Constructor & Destructor Documentation
| PhotographicTonemapData | ( | void | ) |
Default constructor.
Will initialize the data into their default values.
| PhotographicTonemapData | ( | const PhotographicTonemapData & | source | ) |
Copy constructor.
Will make a copy of the source data.
- Parameters:
-
source The data to make a copy of.
Member Function Documentation
| bool IsValid | ( | void | ) | const |
Check if parameters are valid.
Will control if the parameters are within acceptable range.
- Returns:
- true if Parameters are OK.
| bool operator== | ( | const PhotographicTonemapData & | source | ) | const |
Comparison operator.
- Returns:
- true if source parameters are equal to object parameters.
| bool operator!= | ( | const PhotographicTonemapData & | source | ) | const |
Comparison operator.
- Returns:
- true if source parameters are not equal to object parameters.
Member Data Documentation
| bool active |
Data state State can be true or false if the tonemap data should be used or not.
If data isn't active, then tonemapping isn't done and the colors are simply clamped instead. Default: true
| float shutterSpeed |
| float aperture |
| float filmSpeed |
| float highlights |
Increase the brightness of the highlights.
Also known as <<Burn>> Range: 0.0 to 1.0 Default: 0.01
| float midtones |
| float shadows |
Increases the depth of the shadows in the image.
Also known as <<Crushed blacks>="">> Range: 0.0 to 1.0 Default: 0.5
| float colorSaturation |
Saturates or desaturates the colors of the rendering.
Range: 0.0 to 5.0 Default: 1.0
| bool useWhitePointColor |
Specifies whether to color or the temperature parameter should be used to set the white point.
If True whitePointColor is used, if False whitePoint is used. Range: true or false Default: true, use the color parameter.
| float whitePoint |
Specifies the white point of your scene (white balance).
Incandescent lighting: 3000K, Daylighting: 6500K). Only used if useWhitePointColor is false. Range: 100.0 to 10000.0 Default: 6500
| float whitePointColor[3] |
Specifies the white point of your scene (white balance) using a rgb color.
Only used if useWhitePointColor is true. Range: 0.0 to 1.0f for each component. Default: (1.0f, 1.0f, 1.0f) Note: This member can be accessed as a list in Python. data.whitePointColor = (0.5, 0.6, 0.7) print data.whitePointColor >>> [0.5, 0.6, 0.7]
| float vignetting |
Reduces the image brightness in the image periphery compared to the image center.
Range: 0.0 to 25.0 Default: 0.0
| float gamma |
Adjusts intensity curve.
A value of 2.2 should equal a visually linear intensity curve on a computer display. Range: 1.0 to 4.0 Default: 2.2
