D3DXCreateBox function

Uses a left-handed coordinate system to create a mesh containing an axis-aligned box.

Syntax

HRESULT D3DXCreateBox(
  _In_  LPDIRECT3DDEVICE9 pDevice,
  _In_  FLOAT             Width,
  _In_  FLOAT             Height,
  _In_  FLOAT             Depth,
  _Out_ LPD3DXMESH        *ppMesh,
  _Out_ LPD3DXBUFFER      *ppAdjacency
);

Parameters

pDevice [in]

Type: LPDIRECT3DDEVICE9

Pointer to an IDirect3DDevice9 interface, representing the device associated with the created box mesh.

Width [in]

Type: FLOAT

Width of the box, along the x-axis.

Height [in]

Type: FLOAT

Height of the box, along the y-axis.

Depth [in]

Type: FLOAT

Depth of the box, along the z-axis.

ppMesh [out]

Type: LPD3DXMESH*

Address of a pointer to the output shape, an ID3DXMesh interface.

ppAdjacency [out]

Type: LPD3DXBUFFER*

Address of a pointer to an ID3DXBuffer interface. When the method returns, this parameter is filled with an array of three DWORDs per face that specify the three neighbors for each face in the mesh. NULL can be specified.

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, D3DXERR_INVALIDDATA, E_OUTOFMEMORY.

Remarks

The created box is centered at the origin.

This function creates a mesh with the D3DXMESH_MANAGED creation option and D3DFVF_XYZ | D3DFVF_NORMAL flexible vertex format (FVF).

Requirements

Requirement Value
Header
D3dx9shape.h
Library
D3dx9.lib

See also

Shape Drawing Functions