ID3DX10Font::GetDesc method

Get a description of the current font object.

Syntax

HRESULT GetDesc(
  [in] D3DX10_FONT_DESC *pDesc
);

Parameters

pDesc [in]

Type: D3DX10_FONT_DESC*

Pointer to a D3DX10_FONT_DESC structure that describes the font object. If UNICODE is defined, a pointer to a D3DX10FONT_DESCW is returned; otherwise a pointer to a D3DX10FONT_DESCA is returned.

Return value

Type: HRESULT

If the method succeeds, the return value is S_OK. If the method fails, the following value will be returned: D3DERR_INVALIDCALL.

Remarks

This method describes Unicode font objects if UNICODE is defined. Otherwise GetDescA is called, which returns a pointer to the D3DX10FONT_DESCA structure.

Requirements

Requirement Value
Header
D3DX10.h
Library
D3DX10.lib

See also

ID3DX10Font

D3DX Interfaces