TS3DTK_SURFACE

Describes an S3D surface used for framebuffer, zbuffer and textures.

Declaration:

TS3DTK_SURFACE = record
  sfOffset: ULONG;
  sfWidth: ULONG;
  sfHeight: ULONG;
  sfFormat: ULONG;
  reserved: array [0..4] of ULONG;
end;

Fields:

• sfOffset - Where in memory the surface is, depends on where the surface resides.
• sfWidth - Surface width.
• sfHeight - Surface height.
• sfFormat - Pixel or texel format, can be one of the values below.
• reserved - Reserved, should be set to 0s.

Description:

For surfaces containing drawable 2D image data (e.g. framebuffer, sprites, etc), the format can be one of the following values:

• S3DTK_VIDEORGB8 - 8bit per pixel where each pixel is a palette index.
• S3DTK_VIDEORGB15 - 16bit per pixel with a 0RRRRRGGGGGBBBBB arrangement (5 bits per component).
• S3DTK_VIDEORGB24 - 24bit per pixel with a RRRRRRRRGGGGGGGGBBBBBBBB arrangement.

For textures the format can be one of the following values:

• S3DTK_TEXARGB8888 - 32bit per texel with a AAAAAAAARRRRRRRRGGGGGGGGBBBBBBBB arrangement.
• S3DTK_TEXARGB4444 - 16bit per texel with a AAAARRRRGGGGBBBB arrangement.
• S3DTK_TEXARGB1555 - 16bit per texel with a ARRRRRGGGGGBBBBB arrangement.
• S3DTK_TEXPALETTIZED8 - 8bit per texel where each texel is a palette index.

For zbuffers the only acceptable value is S3DTK_Z16 for 16bit per pixel.

Surface location:

Surfaces can reside in either video or system memory. When a surface is in system memory the sfOffset field is the linear memory address (a 32bit pointer casted to ULONG) and their format must be OR'd with S3DTK_SYSTEM. For surfaces in video memory the field is actually the offset from the framebuffer which can be calculated as explained in the Quickstart section. The format can be OR'd with S3DTK_VIDEO but this is just for documentation purposes as the value of that constant is 0.

Unit: S3DTK

See Also:

S3DTK_LinearToPhysical