IDCompositionScaleTransform3D::SetScaleZ(float) method (dcomp.h)

Article
02/22/2024

Changes the value of the ScaleZ property of a 3D scale transform. The ScaleZ property specifies the scale factor along the z-axis.

Syntax

HRESULT SetScaleZ(
  [in] float scaleZ
);

Parameters

[in] scaleZ

Type: float

The new z-axis scale factor.

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 the scaleZ parameter is NaN, positive infinity, or negative infinity.

If the ScaleZ property was previously animated, this method removes the animation and sets the ScaleZ property to the specified static value.

Requirements

Requirement	Value
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