D3DXCreateTorus Function

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

Syntax

HRESULT D3DXCreateTorus(      

    LPDIRECT3DDEVICE9 pDevice,
    FLOAT InnerRadius,
    FLOAT OuterRadius,
    UINT Sides,
    UINT Rings,
    LPD3DXMESH *ppMesh,
    LPD3DXBUFFER *ppAdjacency
);

Parameters

pDevice

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

InnerRadius

[in] Inner-radius of the torus. Value should be greater than or equal to 0.0f.

OuterRadius

[in] Outer-radius of the torus. Value should be greater than or equal to 0.0f.

Sides

[in] Number of sides in a cross-section. Value must be greater than or equal to 3.

Rings

[in] Number of rings making up the torus. Value must be greater than or equal to 3.

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 D3DXCreateTorus function draws a doughnut, centered at (0, 0, 0) whose axis is aligned with the z-axis. The inner-radius of the torus is the radius of the cross-section (the minor-radius), and the outer-radius of the torus is the radius of the central hole.

This function returns a mesh that can be used later for drawing or manipulation by the application.

Function Information

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