IDCompositionEffectGroup::SetTransform3D method

Sets the 3D transformation effect object that modifies the rasterization of the visuals that this effect group is applied to.

Syntax

HRESULT SetTransform3D(
  IDCompositionTransform3D *transform3D
);

Parameters

transform3D

Type: IDCompositionTransform3D*

Pointer to an IDCompositionTransform3D interface or one of its derived interfaces. This parameter can be NULL.

Return Value

Type: HRESULT

If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. See DirectComposition Error Codes for a list of error codes.

Remarks

This method fails if transform3D is an invalid pointer, or if the pointer was not created by the same IDCompositionDevice interface as this effect group. The interface cannot be a custom implementation; only interfaces created by Microsoft DirectComposition can be used with this method.

If the transform3D parameter is NULL, the effect group does not apply any perspective transformations to the visuals. Setting the transform to NULL is equivalent to setting the transform to an IDCompositionMatrixTransform3D object where the specified matrix is the identity matrix. However, an application should use a NULL transform whenever possible because it is slightly faster.

Requirements

   
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header dcomp.h
Library Dcomp.lib
DLL Dcomp.dll

See Also

IDCompositionEffectGroup

IDCompositionMatrixTransform3D

IDCompositionRotateTransform3D

IDCompositionScaleTransform3D

IDCompositionTransform3D

IDCompositionTranslateTransform3D