D3DXCreateCubeTexture function
Creates an empty cube texture, adjusting the calling parameters as needed.
Syntax
HRESULT D3DXCreateCubeTexture(
_In_ LPDIRECT3DDEVICE9 pDevice,
_In_ UINT Size,
_In_ UINT MipLevels,
_In_ DWORD Usage,
_In_ D3DFORMAT Format,
_In_ D3DPOOL Pool,
_Out_ LPDIRECT3DCUBETEXTURE9 *ppCubeTexture
);
Parameters
-
pDevice [in]
-
Type: LPDIRECT3DDEVICE9
Pointer to an IDirect3DDevice9 interface, representing the device to be associated with the texture.
-
Size [in]
-
Type: UINT
Width and height of the cube texture, in pixels. For example, if the cube texture is an 8-pixel by 8-pixel cube, the value for this parameter should be 8.
-
MipLevels [in]
-
Type: UINT
Number of mip levels requested. If this value is zero or D3DX_DEFAULT, a complete mipmap chain is created.
-
Usage [in]
-
Type: DWORD
0, D3DUSAGE_RENDERTARGET, or D3DUSAGE_DYNAMIC. 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. For more information about using dynamic textures, see Using Dynamic Textures.
-
Format [in]
-
Type: D3DFORMAT
Member of the D3DFORMAT enumerated type, describing the requested pixel format for the cube texture. The returned cube texture might have a different format from that specified by Format. Applications should check the format of the returned cube texture.
-
Pool [in]
-
Type: D3DPOOL
Member of the D3DPOOL enumerated type, describing the memory class into which the cube texture should be placed.
-
ppCubeTexture [out]
-
Type: LPDIRECT3DCUBETEXTURE9*
Address of a pointer to an IDirect3DCubeTexture9 interface, representing the created cube texture object.
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_INVALIDCALL, D3DERR_NOTAVAILABLE, D3DERR_OUTOFVIDEOMEMORY, E_OUTOFMEMORY.
Remarks
Cube textures differ from other surfaces in that they are collections of surfaces.
Internally, D3DXCreateCubeTexture uses D3DXCheckCubeTextureRequirements to adjust the calling parameters. Therefore, calls to D3DXCreateCubeTexture will often succeed where calls to CreateCubeTexture would fail.
Requirements
| Requirement | Value |
|---|---|
| Header |
|
| Library |
|
See also