ID3DXLine::Begin method

Prepares a device for drawing lines.

Syntax

HRESULT Begin();

Parameters

This method has no parameters.

Return value

Type: HRESULT

If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DXERR_INVALIDDATA.

Remarks

Calling ID3DXLine::Begin is optional. If called outside of a ID3DXLine::Begin/ID3DXLine::End sequence, the draw functions will internally call ID3DXLine::Begin and ID3DXLine::End. To avoid extra overhead, this method should be used if more than one draw function will be called successively.

This method must be called from inside an IDirect3DDevice9::BeginScene and IDirect3DDevice9::EndScene sequence.

ID3DXLine::Begin cannot be used as a substitute for either IDirect3DDevice9::BeginScene or ID3DXRenderToSurface::BeginScene.

Requirements

Requirement Value
Header
D3dx9core.h
Library
D3dx9.lib

See also

ID3DXLine