ID2D1RenderInfo::SetOutputBuffer method (d2d1effectauthor.h)

Article
06/24/2021

Allows a caller to control the output precision and channel-depth of the transform in which the render information is encapsulated.

Syntax

HRESULT SetOutputBuffer(
  D2D1_BUFFER_PRECISION bufferPrecision,
  D2D1_CHANNEL_DEPTH    channelDepth
);

Parameters

bufferPrecision

Type: D2D1_BUFFER_PRECISION

The type of buffer that should be used as an output from this transform.

channelDepth

Type: D2D1_CHANNEL_DEPTH

The number of channels that will be used on the output buffer.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Remarks

If the output precision of the transform is not specified, then it will default to the precision specified on the Direct2D device context. The maximum of 16bpc UNORM and 16bpc FLOAT is 32bpc FLOAT.

The output channel depth will match the maximum of the input channel depths if the channel depth is D2D1_CHANNEL_DEPTH_DEFAULT.

There is no global output channel depth, this is always left to the control of the transforms.

Requirements

Requirement	Value
Minimum supported client	Windows 8 and Platform Update for Windows 7 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps \| UWP apps]
Target Platform	Windows
Header	d2d1effectauthor.h
Library	D2d1.lib