Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Kinect for Windows 1.6, 1.7, 1.8
Contains the color camera settings.
Syntax
interface INuiColorCameraSettings : public IUnknown
Public Methods
| Name | Description |
|---|---|
| GetAutoExposure | Gets a boolean that determines if automatic exposure is enabled. The values are TRUE (enable) and FALSE (disable); the default value is TRUE. |
| GetAutoWhiteBalance | Gets a boolean that determines if automatic white balance is enabled. The values are TRUE (enable) and FALSE (disable); the default value is TRUE. |
| GetBacklightCompensationMode | Gets the backup lighting compensation mode. The value is one of the values in NUI_BACKLIGHT_COMPENSATION_MODE enumeration; the default value is NUI_BACKLIGHT_COMPENSATION_MODE_AVERAGE_BRIGHTNESS. |
| GetBrightness | Gets the brightness. The range is [0.0, 1.0]; the default value is 0.2156. |
| GetContrast | Gets the contrast. The range is [0.5, 2.0]; the default value is 1.0. |
| GetExposureTime | Gets the exposure time in increments of 1/10,000 of a second. The range is [0, 4000]; the default value is 0.0. |
| GetFrameInterval | Gets the frame interval, in units of 1/10,000 of a second. The range is [0, 4000]; the default value is 0. |
| GetGain | Gets the gain, which is a multiplier for the RGB color values. The range is [1.0, 16.0]; the default value is 1.0. |
| GetGamma | Gets gamma, which is a nonlinear operation for coding luminance data. The range is [1.0, 2.8]; the default value is 2.2. |
| GetHue | Gets the hue, which describes the shade of a color. The range is [+/–22.0]; the default value is 0.0. |
| GetMaxBrightness | Get the maximum brightness. |
| GetMaxContrast | Gets the maximum contrast. |
| GetMaxExposureTime | Gets the maximum exposure time. |
| GetMaxFrameInterval | Gets the maximum frame interval. |
| GetMaxGain | Gets the maximum gain. |
| GetMaxGamma | Gets the maximum gamma value. |
| GetMaxHue | Gets the maximum hue. |
| GetMaxSaturation | Gets the maximum saturation. |
| GetMaxSharpness | Gets the maximum sharpness. |
| GetMaxWhiteBalance | Gets the maximum white balance. |
| GetMinBrightness | Gets the minimum brightness. |
| GetMinContrast | Gets the minimum contrast. |
| GetMinExposureTime | Gets the minimum exposure time. |
| GetMinFrameInterval | Gets the minimum frame interval. |
| GetMinGain | Gets the minimum gain. |
| GetMinGamma | Gets the minimum gamma. |
| GetMinHue | Gets the minimum hue. |
| GetMinSaturation | Gets the minimum saturation. |
| GetMinSharpness | Gets the minimum sharpness. |
| GetMinWhiteBalance | Gets the minimum white balance. |
| GetPowerLineFrequency | Gets the power line frequency. The range is determined by a value in the NUI_POWER_LINE_FREQUENCY enumeration; the default value is NUI_POWER_LINE_FREQUENCY_DISABLED. |
| GetSaturation | Gets the saturation, which is the colorfulness of a color relative to its own brightness. The range is [0.0, 2.0]; the default value is 1.0. |
| GetSharpness | Gets the sharpness, which describes the amount of detail visible. The range is [0, 1.0]; the default value is 0.5. |
| GetWhiteBalance | Gets the white balance, which is a color temperature in degrees Kelvin. The range is [2700, 6500]; the default value is 2700. |
| ResetCameraSettingsToDefault | Resets the color camera settings to default values. |
| SetAutoExposure | Sets a boolean that determines if automatic exposure is enabled. The values are TRUE (enable) and FALSE (disable); the default value is TRUE. |
| SetAutoWhiteBalance | Sets a boolean that determines if automatic white balance is enabled. The values are TRUE (enable) and FALSE (disable); the default value is TRUE. |
| SetBacklightCompensationMode | Sets the backlight compensation mode. The value is one of the values in NUI_BACKLIGHT_COMPENSATION_MODE enumeration; the default value is NUI_BACKLIGHT_COMPENSATION_MODE_AVERAGE_BRIGHTNESS |
| SetBrightness | Sets the brightness. The range is [0.0, 1.0]; the default value is 0.2156. |
| SetContrast | Sets the contrast. The range is [0.5, 2.0]; the default value is 1.0. |
| SetExposureTime | Sets the exposure time in increments of 1/10,000 of a second. The range is [0.0, infinity]; the default value is 0.0. |
| SetFrameInterval | Sets the frame interval, in units of 1/10,000 of a second. The range is [0.0, infinity]; the default value is 0. |
| SetGain | Sets the gain, which is a multiplier for the RGB color values. The range is [1.0, 16.0]; the default value is 1.0. |
| SetGamma | Sets gamma, which is a nonlinear operation for coding luminance data. The range is [1.0, 2.8]; the default value is 2.2. |
| SetHue | Sets the hue, which describes the shade of a color. The range is [+/–22.0]; the default value is 0.0. |
| SetPowerLineFrequency | Sets the power line frequency. The range is determined by a value in the NUI_POWER_LINE_FREQUENCY enumeration; the default value is NUI_POWER_LINE_FREQUENCY_DISABLED. |
| SetSaturation | Sets the saturation, which is the colorfulness of a color relative to its own brightness. The range is [0.0, 2.0]; the default value is 1.0. |
| SetSharpness | Sets the sharpness, which describes the amount of detail visible. The range is [0, 1.0]; the default value is 0.5. |
| SetWhiteBalance | Sets the white balance, which is a color temperature in degrees Kelvin. The range is [2700, 6500]; the default value is 2700. |
Requirements
Header: Declared in NuiSensor.h.