D3DXCheckVolumeTextureRequirements function

Checks volume-texture-creation parameters.

Syntax

HRESULT D3DXCheckVolumeTextureRequirements(
  _In_    LPDIRECT3DDEVICE9 pDevice,
  _Inout_ UINT              *pWidth,
  _Inout_ UINT              *pHeight,
  _Inout_ UINT              *pDepth,
  _Inout_ UINT              *pNumMipLevels,
  _In_    DWORD             Usage,
  _Inout_ D3DFORMAT         *pFormat,
  _In_    D3DPOOL           Pool
);

Parameters

pDevice [in]

Type: LPDIRECT3DDEVICE9

Pointer to an IDirect3DDevice9 interface, representing the device to be associated with the volume texture.

pWidth [in, out]

Type: UINT*

Pointer to the requested width in pixels, or NULL. Returns the corrected size.

pHeight [in, out]

Type: UINT*

Pointer to the requested height in pixels, or NULL. Returns the corrected size.

pDepth [in, out]

Type: UINT*

Pointer to the requested depth in pixels, or NULL. Returns the corrected size.

pNumMipLevels [in, out]

Type: UINT*

Pointer to the number of requested mipmap levels, or NULL. Returns the corrected number of mipmap levels.

Usage [in]

Type: DWORD

Currently not used, set to 0.

pFormat [in, out]

Type: D3DFORMAT*

Pointer to a member of the D3DFORMAT enumerated type. Specifies the desired pixel format, or NULL. Returns the corrected format.

Pool [in]

Type: D3DPOOL

Member of the D3DPOOL enumerated type, describing the memory class into which the volume texture should be placed.

Return value

Type: HRESULT

If the function succeeds, the return value is D3D_OK. If the function fails, the return value can be one of the following: D3DERR_NOTAVAILABLE, D3DERR_INVALIDCALL.

Remarks

If parameters to this function are invalid, this function returns corrected parameters.

Requirements

Requirement	Value
Header	D3dx9tex.h
Library	D3dx9.lib

See also

Texture Functions in D3DX 9