DX::IDXFileBinding Struct Reference
#include <IDXFileBinding.h>
List of all members.
Detailed Description
Controls binding file outputs to interfaces.
Member Enumeration Documentation
FileID is used to identify the file binding to use. For additional texture coordinates, use FileID_TextureCoordinates + index.
Member Function Documentation
virtual void DXMCALL DX::IDXFileBinding::ClearBindings |
( |
|
) |
[pure virtual] |
virtual DXError DXMCALL DX::IDXFileBinding::GetFile |
( |
FileID |
id, |
|
|
IDXFileResourcePtr * |
out | |
|
) |
| | const [pure virtual] |
Get the binding with the specified id.
- Parameters:
-
| id | A member of the FileID enumeration. |
| out | A pointer to an IDXFileResourcePtr where the result will be stored. |
- Returns:
- Error_NullParam if out was null.
Error_NotFound if there was no binding entry with ID.
Error_InvalidParam if the file was not of type IDXFileResource.
Error_Success if the result was stored in out.
virtual DXError DXMCALL DX::IDXFileBinding::GetFile |
( |
FileID |
id, |
|
|
IDXFileInt32Ptr * |
out | |
|
) |
| | const [pure virtual] |
Get the binding with the specified id.
- Parameters:
-
| id | A member of the FileID enumeration. |
| out | A pointer to an IDXFileInt32Ptr where the result will be stored. |
- Returns:
- Error_NullParam if out was null.
Error_NotFound if there was no binding entry with ID.
Error_InvalidParam if the file was not of type IDXFileInt32.
Error_Success if the result was stored in out.
virtual DXError DXMCALL DX::IDXFileBinding::GetFile |
( |
FileID |
id, |
|
|
IDXFileFloat32Ptr * |
out | |
|
) |
| | const [pure virtual] |
Get the binding with the specified id.
- Parameters:
-
| id | A member of the FileID enumeration. |
| out | A pointer to an IDXFileFloat32Ptr where the result will be stored. |
- Returns:
- Error_NullParam if out was null.
Error_NotFound if there was no binding entry with ID.
Error_InvalidParam if the file was not of type IDXFileFloat32.
Error_Success if the result was stored in out.
virtual DXError DXMCALL DX::IDXFileBinding::GetFile |
( |
FileID |
id, |
|
|
IDXFilePtr * |
out | |
|
) |
| | const [pure virtual] |
Get the binding with the specified id.
- Parameters:
-
| id | A member of the FileID enumeration. |
| out | A pointer to an IDXFilePtr where the result will be stored. |
- Returns:
- Error_NullParam if out was null.
Error_NotFound if there was no binding entry with ID.
Error_Success if the result was stored in out.
virtual DXError DXMCALL DX::IDXFileBinding::GetFile |
( |
uint |
index, |
|
|
FileID & |
id, |
|
|
IDXFilePtr * |
out | |
|
) |
| | const [pure virtual] |
Get the file binding at the specified id.
- Parameters:
-
| index | The index of the file to retrieve. |
| id | A reference to a FileID where the file id type will be stored. |
| out | A Pointer to an IDXFilePtr where the result will be stored. |
- 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 uint DX::IDXFileBinding::GetNumFiles |
( |
|
) |
const [pure virtual] |
Get the number of files bound.
- Returns:
- The number of files.
virtual DXError DXMCALL DX::IDXFileBinding::RemoveBinding |
( |
FileID |
id |
) |
[pure virtual] |
Remove the binding of the specified id.
- Parameters:
-
| id | A member of the FileID enumeration. |
- Returns:
- Error_NotFound if there was no binding with this id.
Error_Success if the binding was removed.
virtual DXError DXMCALL DX::IDXFileBinding::SetFile |
( |
FileID |
id, |
|
|
IDXFilePtr |
file | |
|
) |
| | [pure virtual] |
Set the binding of the specfied id.
- Parameters:
-
| id | A member of the FileID enumeration. |
| file | The file to bind to. |
- Returns:
- Error_NullParam if file was null.
Error_Success if the binding was updated.