Class RenderInformation

Namespace

SharpDX.Direct2D1

Assembly

SharpDX.Direct2D1.dll

[Guid("519ae1bd-d19a-420d-b849-364f594776b7")]
public class RenderInformation : ComObject

Inheritance

object

RenderInformation

Derived

ComputeInformation

DrawInformation

Constructors

RenderInformation(nint)

public RenderInformation(nint nativePtr)

Parameters

nativePtr nint

Properties

Cached

Specifies that the output of the transform in which the render information is encapsulated is or is not cached.

public RawBool Cached { set; }

Property Value

RawBool

InstructionCountHint

Provides an estimated hint of shader execution cost to D2D.

public int InstructionCountHint { set; }

Property Value

int

Remarks

The instruction count may be set according to the number of instructions in the shader. This information is used as a hint when rendering extremely large images. Calling this API is optional, but it may improve performance if you provide an accurate number.

Note??Instructions that occur in a loop should be counted according to the number of loop iterations.?

Methods

SetInputDescription(int, InputDescription)

Sets how a specific input to the transform should be handled by the renderer in terms of sampling.

public void SetInputDescription(int inputIndex, InputDescription inputDescription)

Parameters

inputIndex int

The index of the input that will have the input description applied.

inputDescription InputDescription

The description of the input to be applied to the transform.

Remarks

The input description must be matched correctly by the effect shader code.

SetOutputBuffer(BufferPrecision, ChannelDepth)

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

public void SetOutputBuffer(BufferPrecision bufferPrecision, ChannelDepth channelDepth)

Parameters

bufferPrecision BufferPrecision

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

channelDepth ChannelDepth

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

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.

Operators

explicit operator RenderInformation(nint)

public static explicit operator RenderInformation(nint nativePtr)

Parameters

nativePtr nint

Returns

RenderInformation