DirectComposition API
This page is automatically generated from the assembly documentation.
It provides links between managed types and methods in the
SharpDX.DirectCompositionassembly and the original documentation of theDirectCompositionAPI on MSDN.
Microsoft DirectComposition is a Windows component that enables high-performance bitmap composition with transforms, effects, and animation
Enumerations
| Managed | Native |
|---|---|
BackFaceVisibility |
DCOMPOSITION_BACKFACE_VISIBILITY<p>Specifies the backface visibility to be applied to a visual.</p> |
BitmapInterpolationMode |
DCOMPOSITION_BITMAP_INTERPOLATION_MODE<p>Specifies the interpolation mode to be used when a bitmap is composed with any transform where the pixels in the bitmap don’t line up exactly one-to-one with pixels on screen.</p> |
BorderMode |
DCOMPOSITION_BORDER_MODE<p>Specifies the border mode to use when composing a bitmap or applying a clip with any transform such that the edges of the bitmap or clip are not axis-aligned with integer coordinates.</p> |
CompositeMode |
DCOMPOSITION_COMPOSITE_MODE<p>The mode to use to blend the bitmap content of a visual with the render target.</p> |
DepthMode |
DCOMPOSITION_DEPTH_MODE<p>No documentation.</p> |
OpacityMode |
DCOMPOSITION_OPACITY_MODE<p>Specifies how the effective opacity value of a visual is applied to that visual?s content and children.</p> |
Structures
| Managed | Native |
|---|---|
FrameStatistics |
DCOMPOSITION_FRAME_STATISTICS<p>Describes timing and composition statistics for a frame.</p> |
Interfaces
| Managed | Native |
|---|---|
AffineTransform2DEffect<ul><li>BorderMode</li><li>InterpolationMode</li><li>SetSharpness</li><li>SetTransformMatrixElement</li><li>SetTransformMatrixElement</li><li>Sharpness</li></ul> |
IDCompositionAffineTransform2DEffect<ul><li>SetBorderMode</li><li>SetInterpolationMode</li><li>SetSharpness</li><li>SetTransformMatrixElement</li><li>SetTransformMatrixElement</li><li>SetSharpness</li></ul><p>Sets an element of the transform matrix of the effect.</p> |
Animation<ul><li>AbsoluteBeginTime</li><li>AddCubic</li><li>AddRepeat</li><li>AddSinusoidal</li><li>End</li><li>Reset</li></ul> |
IDCompositionAnimation<ul><li>SetAbsoluteBeginTime</li><li>AddCubic</li><li>AddRepeat</li><li>AddSinusoidal</li><li>End</li><li>Reset</li></ul><p>Adds a cubic polynomial segment to the animation function.</p> |
ArithmeticCompositeEffect<ul><li>ClampOutput</li><li>Coefficient1</li><li>Coefficient2</li><li>Coefficient3</li><li>Coefficient4</li><li>SetCoefficient1</li><li>SetCoefficient2</li><li>SetCoefficient3</li><li>SetCoefficient4</li></ul> |
IDCompositionArithmeticCompositeEffect<ul><li>SetClampOutput</li><li>SetCoefficient1</li><li>SetCoefficient2</li><li>SetCoefficient3</li><li>SetCoefficient4</li><li>SetCoefficient1</li><li>SetCoefficient2</li><li>SetCoefficient3</li><li>SetCoefficient4</li></ul><p>The arithmetic composite effect is used to combine 2 images using a weighted sum of pixels from the input images.</p> |
BlendEffect<ul><li>Mode</li></ul> |
IDCompositionBlendEffect<ul><li>SetMode</li></ul><p> The Blend Effect is used to combine 2 images.</p> |
BrightnessEffect<ul><li>BlackPointX</li><li>BlackPointY</li><li>SetBlackPointX</li><li>SetBlackPointY</li><li>SetWhitePointX</li><li>SetWhitePointY</li><li>WhitePointX</li><li>WhitePointY</li></ul> |
IDCompositionBrightnessEffect<ul><li>SetBlackPointX</li><li>SetBlackPointY</li><li>SetBlackPointX</li><li>SetBlackPointY</li><li>SetWhitePointX</li><li>SetWhitePointY</li><li>SetWhitePointX</li><li>SetWhitePointY</li></ul><p>The brightness effect controls the brightness of the image.</p> |
Clip |
IDCompositionClip<p>Represents a clip object that is used to restrict the rendering of a visual subtree to a rectangular area.</p> |
ColorMatrixEffect<ul><li>AlphaMode</li><li>ClampOutput</li><li>SetMatrixElement</li><li>SetMatrixElement</li></ul> |
IDCompositionColorMatrixEffect<ul><li>SetAlphaMode</li><li>SetClampOutput</li><li>SetMatrixElement</li><li>SetMatrixElement</li></ul><p>The color matrix effect alters the RGBA values of a bitmap.</p> |
CompositeEffect<ul><li>Mode</li></ul> |
IDCompositionCompositeEffect<ul><li>SetMode</li></ul><p> The composite effect is used to combine 2 or more images.</p> |
DesktopDevice<ul><li>CreateSurfaceFromHandle</li><li>CreateSurfaceFromHwnd</li></ul> |
IDCompositionDesktopDevice<ul><li>CreateSurfaceFromHandle</li><li>CreateSurfaceFromHwnd</li></ul><p>An application must use the interface in order to use DirectComposition in a Win32 desktop application.</p> |
Device<ul><li>CheckDeviceState</li><li>Commit</li><li>FrameStatistics</li><li>WaitForCommitCompletion</li></ul> |
IDCompositionDevice<ul><li>CheckDeviceState</li><li>Commit</li><li>GetFrameStatistics</li><li>WaitForCommitCompletion</li></ul><p>Serves as a factory for all other Microsoft DirectComposition objects and provides methods to control transactional composition.</p> |
Device2<ul><li>Commit</li><li>FrameStatistics</li><li>WaitForCommitCompletion</li></ul> |
IDCompositionDevice2<ul><li>Commit</li><li>GetFrameStatistics</li><li>WaitForCommitCompletion</li></ul><p>Serves as a factory for all other Microsoft DirectComposition objects and provides methods to control transactional composition.</p> |
Device3<ul><li>CreateAffineTransform2DEffect</li><li>CreateArithmeticCompositeEffect</li><li>CreateBlendEffect</li><li>CreateBrightnessEffect</li><li>CreateColorMatrixEffect</li><li>CreateCompositeEffect</li><li>CreateGaussianBlurEffect</li><li>CreateHueRotationEffect</li><li>CreateLinearTransferEffect</li><li>CreateSaturationEffect</li><li>CreateShadowEffect</li><li>CreateTableTransferEffect</li><li>CreateTurbulenceEffect</li></ul> |
IDCompositionDevice3<ul><li>CreateAffineTransform2DEffect</li><li>CreateArithmeticCompositeEffect</li><li>CreateBlendEffect</li><li>CreateBrightnessEffect</li><li>CreateColorMatrixEffect</li><li>CreateCompositeEffect</li><li>CreateGaussianBlurEffect</li><li>CreateHueRotationEffect</li><li>CreateLinearTransferEffect</li><li>CreateSaturationEffect</li><li>CreateShadowEffect</li><li>CreateTableTransferEffect</li><li>CreateTurbulenceEffect</li></ul><p> Serves as a factory for all other Microsoft DirectComposition objects and provides methods to control transactional composition.</p> |
DeviceDebug<ul><li>DisableDebugCounters</li><li>EnableDebugCounters</li></ul> |
IDCompositionDeviceDebug<ul><li>DisableDebugCounters</li><li>EnableDebugCounters</li></ul><p>Provides access to rendering features that help with application debugging and performance tuning.</p> |
Effect |
IDCompositionEffect<p>Represents a bitmap effect that modifies the rasterization of a visual’s subtree.</p> |
EffectGroup<ul><li>SetOpacity</li><li>SetOpacity</li><li>Transform3D</li></ul> |
IDCompositionEffectGroup<ul><li>SetOpacity</li><li>SetOpacity</li><li>SetTransform3D</li></ul><p>Represents a group of bitmap effects that are applied together to modify the rasterization of a visual’s subtree.</p> |
FilterEffect<ul><li>SetInput</li></ul> |
IDCompositionFilterEffect<ul><li>SetInput</li></ul><p>Represents a filter effect.</p> |
GaussianBlurEffect<ul><li>BorderMode</li><li>SetStandardDeviation</li><li>StandardDeviation</li></ul> |
IDCompositionGaussianBlurEffect<ul><li>SetBorderMode</li><li>SetStandardDeviation</li><li>SetStandardDeviation</li></ul><p></p> |
HueRotationEffect<ul><li>Angle</li><li>SetAngle</li></ul> |
IDCompositionHueRotationEffect<ul><li>SetAngle</li><li>SetAngle</li></ul><p> The hue rotate effect alters the hue of an image by applying a color matrix based on the rotation angle.</p> |
LinearTransferEffect<ul><li>AlphaDisable</li><li>AlphaSlope</li><li>AlphaYIntercept</li><li>BlueDisable</li><li>BlueSlope</li><li>BlueYIntercept</li><li>ClampOutput</li><li>GreenDisable</li><li>GreenSlope</li><li>GreenYIntercept</li><li>RedDisable</li><li>RedSlope</li><li>RedYIntercept</li><li>SetAlphaSlope</li><li>SetAlphaYIntercept</li><li>SetBlueSlope</li><li>SetBlueYIntercept</li><li>SetGreenSlope</li><li>SetGreenYIntercept</li><li>SetRedSlope</li><li>SetRedYIntercept</li></ul> |
IDCompositionLinearTransferEffect<ul><li>SetAlphaDisable</li><li>SetAlphaSlope</li><li>SetAlphaYIntercept</li><li>SetBlueDisable</li><li>SetBlueSlope</li><li>SetBlueYIntercept</li><li>SetClampOutput</li><li>SetGreenDisable</li><li>SetGreenSlope</li><li>SetGreenYIntercept</li><li>SetRedDisable</li><li>SetRedSlope</li><li>SetRedYIntercept</li><li>SetAlphaSlope</li><li>SetAlphaYIntercept</li><li>SetBlueSlope</li><li>SetBlueYIntercept</li><li>SetGreenSlope</li><li>SetGreenYIntercept</li><li>SetRedSlope</li><li>SetRedYIntercept</li></ul><p> The linear transfer effect is used to map the color intensities of an image using a linear function created from a list of values you provide for each channel.</p> |
MatrixTransform<ul><li>SetMatrix</li><li>SetMatrixElement</li><li>SetMatrixElement</li></ul> |
IDCompositionMatrixTransform<ul><li>SetMatrix</li><li>SetMatrixElement</li><li>SetMatrixElement</li></ul><p>Represents an arbitrary affine 2D transformation defined by a 3-by-2 matrix.</p> |
MatrixTransform3D<ul><li>SetMatrix</li><li>SetMatrixElement</li><li>SetMatrixElement</li></ul> |
IDCompositionMatrixTransform3D<ul><li>SetMatrix</li><li>SetMatrixElement</li><li>SetMatrixElement</li></ul><p>Represents an arbitrary 3D transformation defined by a 4-by-4 matrix.</p> |
RectangleClip<ul><li>SetBottom</li><li>SetBottom</li><li>SetBottomLeftRadiusX</li><li>SetBottomLeftRadiusX</li><li>SetBottomLeftRadiusY</li><li>SetBottomLeftRadiusY</li><li>SetBottomRightRadiusX</li><li>SetBottomRightRadiusX</li><li>SetBottomRightRadiusY</li><li>SetBottomRightRadiusY</li><li>SetLeft</li><li>SetLeft</li><li>SetRight</li><li>SetRight</li><li>SetTop</li><li>SetTop</li><li>SetTopLeftRadiusX</li><li>SetTopLeftRadiusX</li><li>SetTopLeftRadiusY</li><li>SetTopLeftRadiusY</li><li>SetTopRightRadiusX</li><li>SetTopRightRadiusX</li><li>SetTopRightRadiusY</li><li>SetTopRightRadiusY</li></ul> |
IDCompositionRectangleClip<ul><li>SetBottom</li><li>SetBottom</li><li>SetBottomLeftRadiusX</li><li>SetBottomLeftRadiusX</li><li>SetBottomLeftRadiusY</li><li>SetBottomLeftRadiusY</li><li>SetBottomRightRadiusX</li><li>SetBottomRightRadiusX</li><li>SetBottomRightRadiusY</li><li>SetBottomRightRadiusY</li><li>SetLeft</li><li>SetLeft</li><li>SetRight</li><li>SetRight</li><li>SetTop</li><li>SetTop</li><li>SetTopLeftRadiusX</li><li>SetTopLeftRadiusX</li><li>SetTopLeftRadiusY</li><li>SetTopLeftRadiusY</li><li>SetTopRightRadiusX</li><li>SetTopRightRadiusX</li><li>SetTopRightRadiusY</li><li>SetTopRightRadiusY</li></ul><p>Represents a clip object that restricts the rendering of a visual subtree to the specified rectangular region.</p> |
RotateTransform<ul><li>SetAngle</li><li>SetAngle</li><li>SetCenterX</li><li>SetCenterX</li><li>SetCenterY</li><li>SetCenterY</li></ul> |
IDCompositionRotateTransform<ul><li>SetAngle</li><li>SetAngle</li><li>SetCenterX</li><li>SetCenterX</li><li>SetCenterY</li><li>SetCenterY</li></ul><p>Represents a 2D transformation that affects the rotation of a visual around the z-axis.</p> |
RotateTransform3D<ul><li>SetAngle</li><li>SetAngle</li><li>SetAxisX</li><li>SetAxisX</li><li>SetAxisY</li><li>SetAxisY</li><li>SetAxisZ</li><li>SetAxisZ</li><li>SetCenterX</li><li>SetCenterX</li><li>SetCenterY</li><li>SetCenterY</li><li>SetCenterZ</li><li>SetCenterZ</li></ul> |
IDCompositionRotateTransform3D<ul><li>SetAngle</li><li>SetAngle</li><li>SetAxisX</li><li>SetAxisX</li><li>SetAxisY</li><li>SetAxisY</li><li>SetAxisZ</li><li>SetAxisZ</li><li>SetCenterX</li><li>SetCenterX</li><li>SetCenterY</li><li>SetCenterY</li><li>SetCenterZ</li><li>SetCenterZ</li></ul><p>Represents a 3D transformation that affects the rotation of a visual along an arbitrary axis in 3D space.</p> |
SaturationEffect<ul><li>Saturation</li><li>SetSaturation</li></ul> |
IDCompositionSaturationEffect<ul><li>SetSaturation</li><li>SetSaturation</li></ul><p> This effect is used to alter the saturation of an image.</p> |
ScaleTransform<ul><li>SetCenterX</li><li>SetCenterX</li><li>SetCenterY</li><li>SetCenterY</li><li>SetScaleX</li><li>SetScaleX</li><li>SetScaleY</li><li>SetScaleY</li></ul> |
IDCompositionScaleTransform<ul><li>SetCenterX</li><li>SetCenterX</li><li>SetCenterY</li><li>SetCenterY</li><li>SetScaleX</li><li>SetScaleX</li><li>SetScaleY</li><li>SetScaleY</li></ul><p>Represents a 2D transformation that affects the scale of a visual along the x-axis and y-axis.</p> |
ScaleTransform3D<ul><li>SetCenterX</li><li>SetCenterX</li><li>SetCenterY</li><li>SetCenterY</li><li>SetCenterZ</li><li>SetCenterZ</li><li>SetScaleX</li><li>SetScaleX</li><li>SetScaleY</li><li>SetScaleY</li><li>SetScaleZ</li><li>SetScaleZ</li></ul> |
IDCompositionScaleTransform3D<ul><li>SetCenterX</li><li>SetCenterX</li><li>SetCenterY</li><li>SetCenterY</li><li>SetCenterZ</li><li>SetCenterZ</li><li>SetScaleX</li><li>SetScaleX</li><li>SetScaleY</li><li>SetScaleY</li><li>SetScaleZ</li><li>SetScaleZ</li></ul><p>Represents a 3D transformation effect that affects the scale of a visual along the x-axis, y-axis, and z-axis.</p> |
ShadowEffect<ul><li>Alpha</li><li>Blue</li><li>Green</li><li>Red</li><li>SetAlpha</li><li>SetBlue</li><li>SetGreen</li><li>SetRed</li><li>SetStandardDeviation</li><li>StandardDeviation</li></ul> |
IDCompositionShadowEffect<ul><li>SetAlpha</li><li>SetBlue</li><li>SetGreen</li><li>SetRed</li><li>SetAlpha</li><li>SetBlue</li><li>SetGreen</li><li>SetRed</li><li>SetStandardDeviation</li><li>SetStandardDeviation</li></ul><p> The shadow effect is used to generate a shadow from the alpha channel of an image.</p> |
SkewTransform<ul><li>SetAngleX</li><li>SetAngleX</li><li>SetAngleY</li><li>SetAngleY</li><li>SetCenterX</li><li>SetCenterX</li><li>SetCenterY</li><li>SetCenterY</li></ul> |
IDCompositionSkewTransform<ul><li>SetAngleX</li><li>SetAngleX</li><li>SetAngleY</li><li>SetAngleY</li><li>SetCenterX</li><li>SetCenterX</li><li>SetCenterY</li><li>SetCenterY</li></ul><p>Represents a 2D transformation that affects the skew of a visual along the x-axis and y-axis.</p> |
Surface<ul><li>BeginDraw</li><li>EndDraw</li><li>ResumeDraw</li><li>Scroll</li><li>SuspendDraw</li></ul> |
IDCompositionSurface<ul><li>BeginDraw</li><li>EndDraw</li><li>ResumeDraw</li><li>Scroll</li><li>SuspendDraw</li></ul><p>Represents a physical bitmap that can be associated with a visual for composition in a visual tree.</p> |
SurfaceFactory |
IDCompositionSurfaceFactory<p>Creates surface and virtual surface objects associated with an application-provided rendering device.</p> |
TableTransferEffect<ul><li>AlphaDisable</li><li>BlueDisable</li><li>ClampOutput</li><li>GreenDisable</li><li>RedDisable</li><li>SetAlphaTable</li><li>SetAlphaTableValue</li><li>SetAlphaTableValue</li><li>SetBlueTable</li><li>SetBlueTableValue</li><li>SetBlueTableValue</li><li>SetGreenTable</li><li>SetGreenTableValue</li><li>SetGreenTableValue</li><li>SetRedTable</li><li>SetRedTableValue</li><li>SetRedTableValue</li></ul> |
IDCompositionTableTransferEffect<ul><li>SetAlphaDisable</li><li>SetBlueDisable</li><li>SetClampOutput</li><li>SetGreenDisable</li><li>SetRedDisable</li><li>SetAlphaTable</li><li>SetAlphaTableValue</li><li>SetAlphaTableValue</li><li>SetBlueTable</li><li>SetBlueTableValue</li><li>SetBlueTableValue</li><li>SetGreenTable</li><li>SetGreenTableValue</li><li>SetGreenTableValue</li><li>SetRedTable</li><li>SetRedTableValue</li><li>SetRedTableValue</li></ul><p>The table transfer effect is used to map the color intensities of an image using a transfer function created from interpolating a list of values you provide.</p> |
Target<ul><li>Root</li></ul> |
IDCompositionTarget<ul><li>SetRoot</li></ul><p>Represents a binding between a Microsoft DirectComposition visual tree and a destination on top of which the visual tree should be composed.</p> |
Transform |
IDCompositionTransform<p>Represents a 2D transformation that can be used to modify the coordinate space of a visual subtree.</p> |
Transform3D |
IDCompositionTransform3D<p>Represents a 3D transformation effect that can be used to modify the rasterization of a visual subtree.</p> |
TranslateTransform<ul><li>SetOffsetX</li><li>SetOffsetX</li><li>SetOffsetY</li><li>SetOffsetY</li></ul> |
IDCompositionTranslateTransform<ul><li>SetOffsetX</li><li>SetOffsetX</li><li>SetOffsetY</li><li>SetOffsetY</li></ul><p>Represents a 2D transformation that affects only the offset of a visual along the x-axis and y-axis.</p> |
TranslateTransform3D<ul><li>SetOffsetX</li><li>SetOffsetX</li><li>SetOffsetY</li><li>SetOffsetY</li><li>SetOffsetZ</li><li>SetOffsetZ</li></ul> |
IDCompositionTranslateTransform3D<ul><li>SetOffsetX</li><li>SetOffsetX</li><li>SetOffsetY</li><li>SetOffsetY</li><li>SetOffsetZ</li><li>SetOffsetZ</li></ul><p>Animates the value of the OffsetZ property of a 3D translation transform effect.</p> |
TurbulenceEffect<ul><li>Noise</li><li>NumOctaves</li><li>Seed</li><li>Stitchable</li></ul> |
IDCompositionTurbulenceEffect<ul><li>SetNoise</li><li>SetNumOctaves</li><li>SetSeed</li><li>SetStitchable</li></ul><p> The turbulence effect is used to generate a bitmap based on the Perlin noise function.</p> |
VirtualSurface<ul><li>Resize</li><li>Trim</li></ul> |
IDCompositionVirtualSurface<ul><li>Resize</li><li>Trim</li></ul><p>Represents a sparsely allocated bitmap that can be associated with a visual for composition in a visual tree.</p> |
Visual<ul><li>AddVisual</li><li>BitmapInterpolationMode</li><li>BorderMode</li><li>CompositeMode</li><li>Content</li><li>Effect</li><li>RemoveAllVisuals</li><li>RemoveVisual</li><li>SetClip</li><li>SetClip</li><li>SetOffsetX</li><li>SetOffsetX</li><li>SetOffsetY</li><li>SetOffsetY</li><li>SetTransform</li><li>SetTransform</li><li>SetTransformParent</li></ul> |
IDCompositionVisual<ul><li>AddVisual</li><li>SetBitmapInterpolationMode</li><li>SetBorderMode</li><li>SetCompositeMode</li><li>SetContent</li><li>SetEffect</li><li>RemoveAllVisuals</li><li>RemoveVisual</li><li>SetClip</li><li>SetClip</li><li>SetOffsetX</li><li>SetOffsetX</li><li>SetOffsetY</li><li>SetOffsetY</li><li>SetTransform</li><li>SetTransform</li><li>SetTransformParent</li></ul><p>Represents a Microsoft DirectComposition visual.</p> |
Visual2<ul><li>BackFaceVisibility</li><li>OpacityMode</li></ul> |
IDCompositionVisual2<ul><li>SetBackFaceVisibility</li><li>SetOpacityMode</li></ul><p>Represents one DirectComposition visual in a visual tree.</p> |
Visual3<ul><li>DepthMode</li><li>OffsetZ</li><li>Opacity</li><li>SetOffsetZ</li><li>SetOpacity</li><li>SetTransform</li><li>Visible</li></ul> |
IDCompositionVisual3<ul><li>SetDepthMode</li><li>SetOffsetZ</li><li>SetOpacity</li><li>SetOffsetZ</li><li>SetOpacity</li><li>SetTransform</li><li>SetVisible</li></ul><p>Represents one DirectComposition visual in a visual tree.</p> |
VisualDebug<ul><li>DisableHeatMap</li><li>DisableRedrawRegions</li><li>EnableHeatMap</li><li>EnableRedrawRegions</li></ul> |
IDCompositionVisualDebug<ul><li>DisableHeatMap</li><li>DisableRedrawRegions</li><li>EnableHeatMap</li><li>EnableRedrawRegions</li></ul><p>Represents a debug visual.</p> |