Bink SDK 1.5v

# BINKBUFFER

The structure BINKBUFFER is a structure returned from BinkBufferOpen.

    struct BINKBUFFER
    {
      U32 Width;
      U32 Height;
      VOID_PTR Buffer;
      S32 BufferPitch;
      BINK_COPY_FLAGS SurfaceType;
      U32 WindowWidth;
      U32 WindowHeight;
      U32 ScreenWidth;
      U32 ScreenHeight;
      U32 ScreenDepth;
    };

#### Out Members

Width
  Specifies the width of the BinkBuffer.
Height
  Specifies the height of the BinkBuffer.
Buffer
  Specifies the address of the internal pixel buffer. This value is only valid inside of BinkBufferLock and BinkBufferUnlock function calls.
BufferPitch
  Specifies the pitch in bytes of the internal pixel buffer. This value is only valid inside of BinkBufferLock and BinkBufferUnlock function calls.
SurfaceType
  Specifies the flags that should be passed to BinkCopyToBuffer to copy into this BinkBuffer correctly.
WindowWidth
  Specifies the width that you should set your window to - it takes into account alignment and the window style of the window that you pass to BinkBufferOpen.
WindowHeight
  Specifies the height that you should set your window to - it takes into account alignment and the window style of the window that you pass to BinkBufferOpen.
ScreenWidth
  Specifies the current width of the screen in pixels. This is useful to see if your resolution change request was successful.
ScreenHeight
  Specifies the current height of the screen in pixels. This is useful to see if your resolution change request was successful.
ScreenDepth
  Specifies the current color depth of the screen (8, 16, 24, or 32) in bits. This is useful to see if your resolution change request was successful.

#### Discussion

The BINKBUFFER structure is pointed to by the HBINKBUFFER handle that is returned from BinkBufferOpen. You can dereference the pointer to access any of these information fields. Note that you should never change any of these values!

Group: BinkBuffer API
Related Functions: BinkBufferLock, BinkBufferOpen, BinkBufferUnlock, BinkCopyToBuffer
Related Basic Types: BINK_COPY_FLAGS, HBINKBUFFER, S32, U32, VOID_PTR

For technical support, e-mail Bink1@radgametools.com
© Copyright 1994-2003 RAD Game Tools, Inc. All Rights Reserved.