IDXSurface Interface

CLSID_DXSurface

{0E890F83-5F79-11D1-9043-00C04FD9189D}

IID_IDXSurface

{B39FD73F-E139-11D1-9065-00C04FD9189D}

The IDXSurface interface is used to access DXSurface objects, which store images.

MSDN Documentation: IDXSurface

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IDXBaseObject Members

Description

GetGenerationId

Retrieves the current generation ID for the object.

IncrementGenerationId

Manually increments the object generation ID.

GetObjectSize

Retrieves the size, in bytes, of the data object (for example, a surface or buffer).

IDXSurface Members

Description

GetPixelFormat

Retrieves the pixel format of the surface.

GetBounds

Retrieves a structure that contains the surface's boundary region.

GetStatusFlags

Retrieves the status flags of the DXSurface object.

SetStatusFlags

Sets the status flags of the DXSurface object.

LockSurface

Locks a region of the surface and returns a pointer through which you can access samples on DXSurfaces.

GetDirectDrawSurface

Retrieves an interface on the underlying IDXSurface::GetDirectDrawSurface object if the DXSurface object is aggregated onto a IDXSurface::GetDirectDrawSurface.

GetColorKey

Retrieves the surface's color key value.

SetColorKey

Sets the surface's color_key value.

LockSurfaceDC

Locks a region of the surface and returns an IDXDCLock interface.

SetAppData

Sets the surface's application-specified DWORD of data.

GetAppData

Retrieves an application-specific DWORD of data.

GetPixelFormat

FUNCTION IDXSurface_GetPixelFormat ( _
  BYVAL pthis AS DWORD PTR _

, BYREF pFormatID AS GUID _

, BYREF pSampleFormatEnum AS LONG _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[6] USING IDXSurface_GetPixelFormat (pthis, pFormatID, pSampleFormatEnum) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetBounds

FUNCTION IDXSurface_GetBounds ( _
  BYVAL pthis AS DWORD PTR _

, BYREF pBounds AS DXBNDS _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[7] USING IDXSurface_GetBounds (pthis, pBounds) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetStatusFlags

FUNCTION IDXSurface_GetStatusFlags ( _
  BYVAL pthis AS DWORD PTR _

, BYREF pdwStatusFlags AS DWORD _

  ) AS LONG
 

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[8] USING IDXSurface_GetStatusFlags (pthis, pdwStatusFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SetStatusFlags

FUNCTION IDXSurface_SetStatusFlags ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL dwStatusFlags AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[9] USING IDXSurface_SetStatusFlags (pthis, dwStatusFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

LockSurface

FUNCTION IDXSurface_LockSurface ( _
  BYVAL pthis AS DWORD PTR _

, BYREF pBounds AS DXBNDS _

, BYVAL ulTimeOut AS DWORD _

, BYVAL dwFlags AS DWORD _

, BYREF riid AS GUID _

, BYREF ppPointer AS DWORD _

, BYREF pulGenerationId AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[10] USING IDXSurface_LockSurface (pthis, pBounds, ulTimeOut, dwFlags, riid, ppPointer, pulGenerationId) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetDirectDrawSurface

FUNCTION IDXSurface_GetDirectDrawSurface ( _
  BYVAL pthis AS DWORD PTR _

, BYREF riid AS GUID _

, BYREF ppSurface AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[11] USING IDXSurface_GetDirectDrawSurface (pthis, riid, ppSurface) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetColorKey

FUNCTION IDXSurface_GetColorKey ( _
  BYVAL pthis AS DWORD PTR _

, BYREF pColorKey AS DXSAMPLE _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[12] USING IDXSurface_GetColorKey (pthis, pColorKey) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SetColorKey

FUNCTION IDXSurface_SetColorKey ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL ColorKey AS DXSAMPLE _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[13] USING IDXSurface_SetColorKey (pthis, ColorKey) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

LockSurfaceDC

FUNCTION IDXSurface_LockSurfaceDC ( _
  BYVAL pthis AS DWORD PTR _

, BYREF pBounds AS DXBNDS _

, BYVAL ulTimeOut AS DWORD _

, BYVAL dwFlags AS DWORD _

, BYREF ppDCLock AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[14] USING IDXSurface_LockSurfaceDC (pthis, pBounds, ulTimeOut, dwFlags, ppDCLock) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SetAppData

FUNCTION IDXSurface_SetAppData ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL dwAppData AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[15] USING IDXSurface_SetAppData (pthis, dwAppData) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetAppData

FUNCTION IDXSurface_GetAppData ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL pdwAppData AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[16] USING IDXSurface_GetAppData (pthis, pdwAppData) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION