ID2D1CommandSink interface (d2d1_1.h)
The command sink is implemented by you for an application when you want to receive a playback of the commands recorded in a command list. A typical usage will be for transforming the command list into another format such as XPS when some degree of conversion between the Direct2D primitives and the target format is required.
The command sink interface doesn't have any resource creation methods on it. The resources are still logically bound to the Direct2D device on which the command list was created and will be passed in to the command sink implementation.
Inheritance
The ID2D1CommandSink interface inherits from the IUnknown interface. ID2D1CommandSink also has these types of members:
Methods
The ID2D1CommandSink interface has these methods.
| ID2D1CommandSink::BeginDraw Notifies the implementation of the command sink that drawing is about to commence. |
| ID2D1CommandSink::Clear Clears the drawing area to the specified color. (ID2D1CommandSink.Clear) |
| ID2D1CommandSink::DrawBitmap Draws a bitmap to the render target. (ID2D1CommandSink.DrawBitmap) |
| ID2D1CommandSink::DrawGdiMetafile Draw a metafile to the device context. (ID2D1CommandSink.DrawGdiMetafile) |
| ID2D1CommandSink::DrawGeometry Indicates the geometry to be drawn to the command sink. |
| ID2D1CommandSink::DrawGlyphRun Indicates the glyphs to be drawn. |
| ID2D1CommandSink::DrawImage Draws the provided image to the command sink. |
| ID2D1CommandSink::DrawLine Draws a line drawn between two points. |
| ID2D1CommandSink::DrawRectangle Draws a rectangle. |
| ID2D1CommandSink::EndDraw Indicates when ID2D1CommandSink processing has completed. |
| ID2D1CommandSink::FillGeometry Indicates to the command sink a geometry to be filled. |
| ID2D1CommandSink::FillMesh Indicates a mesh to be filled by the command sink. |
| ID2D1CommandSink::FillOpacityMask Fills an opacity mask on the command sink. |
| ID2D1CommandSink::FillRectangle Indicates to the command sink a rectangle to be filled. |
| ID2D1CommandSink::PopAxisAlignedClip Removes an axis-aligned clip from the layer and clip stack. |
| ID2D1CommandSink::PopLayer Removes a layer from the layer and clip stack. |
| ID2D1CommandSink::PushAxisAlignedClip Pushes a clipping rectangle onto the clip and layer stack. |
| ID2D1CommandSink::PushLayer Pushes a layer onto the clip and layer stack. |
| ID2D1CommandSink::SetAntialiasMode Sets the antialiasing mode that will be used to render any subsequent geometry. |
| ID2D1CommandSink::SetPrimitiveBlend Sets a new primitive blend mode. (ID2D1CommandSink.SetPrimitiveBlend) |
| ID2D1CommandSink::SetTags Sets the tags that correspond to the tags in the command sink. |
| ID2D1CommandSink::SetTextAntialiasMode Indicates the new default antialiasing mode for text. |
| ID2D1CommandSink::SetTextRenderingParams Indicates more detailed text rendering parameters. |
| ID2D1CommandSink::SetTransform Sets a new transform. |
| ID2D1CommandSink::SetUnitMode The unit mode changes the meaning of subsequent units from device-independent pixels (DIPs) to pixels or the other way. The command sink does not record a DPI, this is implied by the playback context or other playback interface such as ID2D1PrintControl. |
Remarks
The ID2D1CommandSink can be implemented to receive a play-back of the commands recorded in a command list. This interface is typically used for transforming the command list into another format where some degree of conversion between the Direct2D primitives and the target format is required.
The ID2D1CommandSink interface does not have any resource creation methods. The resources are logically bound to the Direct2D device on which the ID2D1CommandList was created and will be passed in to the ID2D1CommandSink implementation.
Not all methods implemented by ID2D1DeviceContext are present.
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 | d2d1_1.h |