Export (0) Print
Expand All
Expand Minimize

VideoProcessorSetStreamLumaKey function

Sets the luma key for an input stream on the video processor.

Syntax


VOID APIENTRY* VideoProcessorSetStreamLumaKey(
  _In_  D3D10DDI_HDEVICE hDevice,
  _In_  D3D11_1DDI_HVIDEOPROCESSOR hVideoProcessor,
  _In_  UINT StreamIndex,
  _In_  BOOL Enable,
  _In_  FLOAT Lower,
  _In_  FLOAT Upper
);

Parameters

hDevice [in]

A handle to the display device (graphics context).

hVideoProcessor [in]

A handle to the video processor object that was created through a call to the CreateVideoProcessor function.

StreamIndex [in]

The zero-based index of the input stream.

Enable [in]

If TRUE, the luma key is enabled on the specified input stream of the video processor.

Lower [in]

The lower bound for the luma key. The valid range is from zero to one.

Note  If the Enable parameter is FALSE, this parameter is ignored.

Upper [in]

The upper bound for the luma key. The valid range is from zero to one.

Note  If the Enable parameter is FALSE, this parameter is ignored.

Return value

This function does not return a value.

Remarks

The values of Lower and Upper give the lower and upper bounds of the luma key by using a nominal range from zero to one. Given a format with n bits per channel, these values are converted to luma values as follows:

val = f * ((1 << n)-1)

Any pixel whose luma value falls within the upper and lower bounds (inclusive) is treated as transparent.

For example, if the pixel format uses 8-bit luma, the upper bound is calculated as follows:

BYTE Y = BYTE(max(min(1.0, Upper), 0.0) * 255.0)

Note that the value is clamped to the range from zero to one before multiplying by 255.

The driver reports its ability to support stereo alpha blending for an input stream in the D3D11_1DDI_VIDEO_PROCESSOR_CAPS structure that is returned through the GetVideoProcessorCaps function. If the driver supports the D3D11_1DDI_VIDEO_PROCESSOR_FEATURE_CAPS_LUMA_KEY capability, it can be enabled or disabled to set a luma key on an input stream of the video processor.

Note  If the driver does not support the D3D11_1DDI_VIDEO_PROCESSOR_FEATURE_CAPS_LUMA_KEY capability, the Microsoft Direct3D runtime does not call the VideoProcessorSetStreamLumaKey function.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Header

D3d10umddi.h (include D3d10umddi.h)

See also

CreateVideoProcessor
D3D11_1DDI_VIDEO_PROCESSOR_CAPS
GetVideoProcessorCaps

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft