directcomposition.md

layout	wiki
title	DirectComposition API

This page is automatically generated from the assembly documentation.

It provides links between managed types and methods in the SharpDX.DirectComposition assembly and the original documentation of the DirectComposition API on MSDN.

Microsoft DirectComposition is a Windows component that enables high-performance bitmap composition with transforms, effects, and animation

• Enumerations
• Structures
• Interfaces

Enumerations

Managed	Native
BackFaceVisibility	DCOMPOSITION_BACKFACE_VISIBILITY Specifies the backface visibility to be applied to a visual.
BitmapInterpolationMode	DCOMPOSITION_BITMAP_INTERPOLATION_MODE 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.
BorderMode	DCOMPOSITION_BORDER_MODE 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.
CompositeMode	DCOMPOSITION_COMPOSITE_MODE The mode to use to blend the bitmap content of a visual with the render target.
DepthMode	DCOMPOSITION_DEPTH_MODE No documentation.
OpacityMode	DCOMPOSITION_OPACITY_MODE Specifies how the effective opacity value of a visual is applied to that visual?s content and children.

Structures

Managed	Native
FrameStatistics	DCOMPOSITION_FRAME_STATISTICS Describes timing and composition statistics for a frame.

Interfaces

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