GA_buf

Declaration

typedef struct {
    N_uint32        dwSize;
    N_int32         Width;
    N_int32         Height;
    N_int32         Stride;
    N_int32         CacheStride;
    N_int32         StartX;
    N_int32         StartY;
    N_int32         Offset;
    N_int32         Flags;
    N_int32         Format;
    N_int32         UseageCount;
    void            *Surface;
    void            *SurfaceCache;
    void            *AppInfo;
    } GA_buf

Prototype In

snap/graphics.h

Description

Generic offscreen managed buffer structure, which is used to describe offscreen managed buffers, and is allocated using the AllocBuffer function. Offscreen managed buffers are used to allocate and manage offscreen video memory and system memory buffers.

Note:    If the buffer is linear based, the StartX and StartY members will contain a value of -1.

Note:    The dwSize member is intended for future compatibility, and should be set to the size of the structure as defined in this header file. Future drivers will be compatible with older software by examiming this value.

Members

dwSize

Set to size of structure in bytes

Width

Width of buffer in pixels

Height

Height of the buffer in pixels

Stride

Stride of the buffer in bytes (bytes for a line of data)

CacheStride

Stride of the buffer in system memory buffer cache

StartX

Starting X coordinate in framebuffer for buffer (if x,y based)

StartY

Starting Y coordinate in framebuffer for buffer (if x,y based)

Offset

Linear buffer starting address in bytes

Flags

Flags for the buffer (GA_BufferFlagsType)

Format

Internal format indicator for the buffer

UseageCount

Useage count for tracking pageable buffers

Surface

Pointer to start of the buffer surface

SurfaceCache

Pointer to surface cache in system memory (NULL if uncached)

AppInfo

Pointer to application data if necessary

 

Copyright © 2002 SciTech Software, Inc. Visit our web site at http://www.scitechsoft.com