DX::IDXFileResource Struct Reference

#include <IDXFileResource.h>

Inherits DX::IDXFile.

Collaboration diagram for DX::IDXFileResource:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual const wchar_t *DXMCALL GetSource () const =0
virtual DXError DXMCALL Add (byte value)=0
virtual DXError DXMCALL Add (ByteArray values, uint length)=0
virtual DXError DXMCALL Add (ByteArray values, uint length, uint start)=0
virtual DXError DXMCALL SetSource (const wchar_t *source)=0
virtual DXError DXMCALL Set (ByteArray array, uint length)=0
virtual DXError DXMCALL Remove (uint index)=0
virtual DXError DXMCALL Remove (uint start, uint count)=0


Detailed Description

Interface for file resources. Things like textures, or things that the user just wants included.

Member Function Documentation

virtual DXError DXMCALL DX::IDXFileResource::Add ( ByteArray  values,
uint  length,
uint  start 
) [pure virtual]

Insert an array of values into the data.

Parameters:
values A byte array to add.
length The number of bytes to add.
start The index to insert the bytes.
Returns:
Error_NullParam if values was null.
Error_OutOfRange if start was out of range.
Error_Success if the values were inserted.

virtual DXError DXMCALL DX::IDXFileResource::Add ( ByteArray  values,
uint  length 
) [pure virtual]

Add an array of bytes to the end of the file.

Parameters:
values An array of bytes to append.
length The number of bytes to add.
Returns:
Error_NullParam if values was null.
Error_Success if the values were added.

virtual DXError DXMCALL DX::IDXFileResource::Add ( byte  value  )  [pure virtual]

Add a byte to the end of the file.

Parameters:
value The byte to add.
Returns:
Error_Success always.

virtual const wchar_t* DXMCALL DX::IDXFileResource::GetSource (  )  const [pure virtual]

Get the filename that this resource comes from.

Returns:
A wchar_t* which is the filename.

virtual DXError DXMCALL DX::IDXFileResource::Remove ( uint  start,
uint  count 
) [pure virtual]

Remove a range of elements from the file.

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 element was removed.

virtual DXError DXMCALL DX::IDXFileResource::Remove ( uint  index  )  [pure virtual]

Remove the element at the specified index.

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

virtual DXError DXMCALL DX::IDXFileResource::Set ( ByteArray  array,
uint  length 
) [pure virtual]

Set the data in this file.

Parameters:
array An array of bytes to use for the data.
length The number of bytes.
Returns:
Error_NullParam if array was null.
Error_Success if the data was set.

virtual DXError DXMCALL DX::IDXFileResource::SetSource ( const wchar_t *  source  )  [pure virtual]

Set the filename that this resource comes from. This is not the filename that will be used in the zip.

Parameters:
source The source filename
Returns:
Error_NullParam if source was null.
Error_Success if source was set.


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