S3DTK_GetState

Get a S3D state.

Method of:

Syntax:

S3DTK_GetState: function(
  pFuncStruct: Pointer;
  State: ULONG;
  Value: ULONG): ULONG; cdecl;

Parameters:

• pFuncStruct - Pointer to the TS3DTK_FUNCTION_LIST that contains this method.
• State - One of the state constants described below.
• Value - Pointer to memory that will receive the data (yes, this is really meant to be a pointer).

Returns:

S3DTK_OK if successful, S3DTK_ERR otherwise.

States:

The valid values for the State parameter and the potential values the Value parameter can have are listed in S3DTK_SetState. In addition to the values listed there, the following values can also be queried:

• S3DTK_VERSION - Returns the version of the S3D library in a ULONG. The format is $MMmm where MM is the major version and mm is the minor version.
• S3DTK_VIDEOMEMORYADDRESS - Returns the linear address of the video memory. Use S3DTK_LinearToPhysical to convert it to a physical address that can be used for calculating offsets for surfaces in video memory.
• S3DTK_DISPLAYADDRESSUPDATED - If this is S3DTK_YES the display address has changed.
• S3DTK_GRAPHICS_ENGINE_IDLE - Returns S3DTK_TRUE if the S3D engine is idle. This could be useful for updating textures, however using DDLOCK_WAIT during locking is actually simpler.

Unit: S3DTK

See Also:

S3DTK_SetState (in TS3DTK_FUNCTION_LIST)