PhotometricLight.colorPreset Property

This functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

Gets and sets the standard illuminant preset used to define the color when the color mode is Kelvin. Use Custom to specify the temperature directly. When a photometric light is created, the default preset is CustomPhotometricColorPreset.

Syntax

# Get the value of the property.
propertyValue = photometricLight_var.colorPreset

# Set the value of the property.
photometricLight_var.colorPreset = propertyValue

#include <Fusion/Render/PhotometricLight.h>

// Get the value of the property.
PhotometricColorPresets propertyValue = photometricLight_var->colorPreset();

// Set the value of the property, where value_var is a PhotometricColorPresets.
bool returnValue = photometricLight_var->colorPreset(value_var);

// Get the value of the property.
propertyValue = photometricLight_var.colorPreset;

// Set the value of the property.
photometricLight_var.colorPreset = propertyValue;

Property Value

Version