Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The TDx_DrawSurface::SetPrivateData method will associate application specific data with the surface.
Multiple sets of data may be associated with a surface.
The memory referenced by the Data parameter is not managed by TDx_Draw, so if the buffer was dynamically allocated, it is the applications responsibility to free the memory.
If the method call fails, the OnError event will be triggered with one of the following values:
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_OUTOFMEMORY
- Parameters
Tag
The Tag parameter references the GUID of the private data that is to be set.
Data
The Data parameter references the buffer holding the private data that is to be associated with the surface.
Size
The Size parameter defines the size, in bytes, of the buffer referenced by the Data parameter of this method.
Flags
The Flags parameter defines flags indicating the type of data being associated and its lifetime.
The described effect applies when the flag is set.
Setting no flags causes the data to be stored in a buffer allocated by TDx_Draw, which will be freed when appropriate.
-
DDSPD_IUNKNOWNPOINTER
The information referenced by the Data parameter of this method references an IUnknown interface.
The interface's reference count will be incremented and then decremented when the data is no longer needed.
DDSPD_VOLATILE
The data being associated will only remain valid until the current state of the surface changes.
Attempts to retrieve the data after the surface has changed will return DDERR_EXPIRED.
- See Also
- Top
TDx_Draw_Library v2.00 Component Reference
|
|
|
[ TDx_DrawSurface::SetPrivateData() ] [ next: SetSurfaceDesc() ] [ prev: SetPriority() ] public:
virtual bool __fastcall SetPrivateData( REFGUID pTag, void* pData, dword pSize, dword pFlags );
TDX_DRAWSURFACE::SETPRIVATEDATA()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|