A3DGlobalGetGraphHatchingPatternData

A3DStatus A3DGlobalGetGraphHatchingPatternData(const A3DUns32 uiIndexHatchingPattern, A3DGraphHatchingPatternData *pData)
A3DStatus A3DGlobalGetGraphHatchingPatternData(const A3DUns32 uiIndexHatchingPattern, A3DGraphHatchingPatternData* pData)

Retrieves an A3DGraphHatchingPatternData instance.

2.0

HOOPS stores pattern information in a global state using indexes. When given an index, you may call A3DGlobalGetGraphHatchingPatternData to fill in an A3DGraphHatchingPatternData instance.

Return Values

A3D_SUCCESS: in case of success.

A3D_INITIALIZE_NOT_CALLED: if the library is not initialized

A3D_INVALID_PATTERN_INDEX: if uiIndexHatchingPattern does not match any existing.

A3D_BASEWITHGRAPHICS_BAD_ENTITY_TYPE: if uiIndexHatchingPattern is invalid but indexes an other pattern type (either A3DGraphDottingPatternData, A3DGraphSolidPatternData or A3DGraphVPicturePatternData)

A3D_INVALID_DATA_STRUCT_NULL: if pData is null.

A3D_INVALID_DATA_STRUCT_SIZE: if pData is incorrectly initialized

// Retrieves the pattern data at index 3:
A3DGraphHatchingPatternData pattern_data = A3D_MAKE_DATA(A3DGraphHatchingPatternData);
A3DStatus result = A3DGlobalGetGraphHatchingPatternData(3, &pattern_data);
assert(result == A3D_SUCCESS);
// Frees it:
A3DGlobalGetGraphHatchingPatternData(A3D_DEFAULT_PATTERN_INDEX, &descriptor);

Parameters

uiIndexHatchingPattern: The index of the pattern.

pData: The A3DGraphHatchingPatternData to fill in.

Returns

A3D_SUCCESS or an error code in case of failure.