D3DXCreateCylinder Function

Uses a left-handed coordinate system to create a mesh containing a cylinder.

Syntax

HRESULT D3DXCreateCylinder(      

    LPDIRECT3DDEVICE9 pDevice,
    FLOAT Radius1,
    FLOAT Radius2,
    FLOAT Length,
    UINT Slices,
    UINT Stacks,
    LPD3DXMESH *ppMesh,
    LPD3DXBUFFER *ppAdjacency
);

Parameters

pDevice

[in] Pointer to an IDirect3DDevice9 interface, representing the device associated with the created cylinder mesh.

Radius1

[in] Radius at the negative Z end. Value should be greater than or equal to 0.0f.

Radius2

[in] Radius at the positive Z end. Value should be greater than or equal to 0.0f.

Length

[in] Length of the cylinder along the z-axis.

Slices

[in] Number of slices about the main axis.

Stacks

[in] Number of stacks along the main axis.

ppMesh

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

ppAdjacency

[out] 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

If the function succeeds, the return value is D3D_OK.

If the function fails, the return value can be one of the following values.

D3DERR_INVALIDCALL	The method call is invalid. For example, a method's parameter may have an invalid value.
D3DXERR_INVALIDDATA	The data is invalid.
E_OUTOFMEMORY	Microsoft?Direct3D?could not allocate sufficient memory to complete the call.

Remarks

The created cylinder is centered at the origin, and its axis is aligned with the z-axis.

Function Information

Header	d3dx9shape.h
Import library	d3dx9.lib
Minimum operating systems	Windows 98