DX::IDXLightMap Struct Reference

#include <IDXLightMap.h>

Inherits DX::IDXMaterialMap.

Collaboration diagram for DX::IDXLightMap:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual uint DXMCALL GetGenerateSize () const =0
virtual uint DXMCALL GetNumLights () const =0
virtual DXError DXMCALL GetLight (uint index, const char **out) const =0
virtual DXError DXMCALL GetLightIndex (const char *id, uint *out) const =0
virtual DXError DXMCALL SetGenerateSize (uint value)=0
virtual DXError DXMCALL AddLight (const char *id)=0
virtual DXError DXMCALL RemoveLight (uint index)=0
virtual DXError DXMCALL RemoveLight (const char *id)=0
virtual DXError DXMCALL RemoveLight (uint start, uint count)=0
virtual void DXMCALL ClearLights ()=0


Detailed Description

Controls properties specific to lightmaps.

Member Function Documentation

virtual DXError DXMCALL DX::IDXLightMap::AddLight ( const char *  id  )  [pure virtual]

Add a light to the list of lights that this lightmap is used for.

Parameters:
id The id of the light.
Returns:
Error_NullParam if id was null.
Error_Success if the id was added to the list.

virtual void DXMCALL DX::IDXLightMap::ClearLights (  )  [pure virtual]

Remove all the lights from the list of lights that this lightmap will be used for.

virtual uint DXMCALL DX::IDXLightMap::GetGenerateSize (  )  const [pure virtual]

Get the size of the texture that will be used in light baking.

virtual DXError DXMCALL DX::IDXLightMap::GetLight ( uint  index,
const char **  out 
) const [pure virtual]

Get the name of the light at the specified index in the list of lights that this lightmap will be used for.

Returns:
Error_NullParam if out was null.
Error_OutOfRange if index was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXLightMap::GetLightIndex ( const char *  id,
uint *  out 
) const [pure virtual]

Get the index of the specified light id.

Parameters:
id The id to search for
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if id was null.
Error_NotFound if the id was not found on this map.
Error_Success if the result was stored in out.

virtual uint DXMCALL DX::IDXLightMap::GetNumLights (  )  const [pure virtual]

Returns:
The number of lights that this lightmap will be used for,

virtual DXError DXMCALL DX::IDXLightMap::RemoveLight ( uint  start,
uint  count 
) [pure virtual]

Remove a range of lights from the list of lights that this lightmap will be used for.

Parameters:
start The index of the first element to remove
count The number of elements to remove
Returns:
Error_OutOfRange if start was out of range.
Error_Success if the range was removed.

virtual DXError DXMCALL DX::IDXLightMap::RemoveLight ( const char *  id  )  [pure virtual]

Remove a light from the list of lights that this lightmap is used for which has the specified id.

Parameters:
id The id of the light to remove.
Returns:
Error_NullParam if id was null.
Error_NotFound if there are no lights that match the specified id.
Error_Success if the light was removed.

virtual DXError DXMCALL DX::IDXLightMap::RemoveLight ( uint  index  )  [pure virtual]

Remove a light from the list of lights that this lightmap will be used for.

Parameters:
index The index of the light to remove.
Returns:
Error_OutOfRange if index was out of range.
Error_Success if the light at the index was removed.

virtual DXError DXMCALL DX::IDXLightMap::SetGenerateSize ( uint  value  )  [pure virtual]

Set the size of the texture that will be used in light baking. Must be power of 2 (or 0 )

Parameters:
value The length of the side of the texture to be created.
Returns:
Error_InvalidParam if value was not a power of 2, or was not 0.
Error_Success if the generate size was changed.


Generated on Wed Jun 17 17:24:50 2009 for DXMesh API by  doxygen 1.5.7.1