D3DXCheckCubeTextureRequirements function
Checks cube-texture-creation parameters.
Syntax
HRESULT D3DXCheckCubeTextureRequirements(
_In_ LPDIRECT3DDEVICE9 pDevice,
_Inout_ UINT *pSize,
_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 cube texture.
-
pSize [in, out]
-
Type: UINT*
Pointer to the requested width and height 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
0 or D3DUSAGE_RENDERTARGET. Setting this flag to D3DUSAGE_RENDERTARGET indicates that the surface is to be used as a render target. The resource can then be passed to the pNewRenderTarget parameter of the SetRenderTarget method. If D3DUSAGE_RENDERTARGET is specified, the application should check that the device supports this operation by calling CheckDeviceFormat.
-
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 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.
Cube textures differ from other surfaces in that they are collections of surfaces. To call SetRenderTarget with a cube texture, you must select an individual face using GetCubeMapSurface and pass the resulting surface to SetRenderTarget.
Requirements
| Requirement | Value |
|---|---|
| Header |
|
| Library |
|
See also