IDXSurfaceModifier Interface

CLSID_DXSurfaceModifier

{3E669F1D-9C23-11D1-9053-00C04FD9189D}

IID_IDXSurfaceModifier

{9EA3B637-C37D-11D1-905E-00C04FD9189D}

The IDXSurfaceModifier interface is a procedural surface that uses up to two input surfaces. The methods of this interface set background colors, background surfaces, and foreground surfaces, which the DXSurfaceModifier object (Surface Modifier) uses to create another surface based on the options you set.

MSDN documentation: IDXSurfaceModifier.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IDXSurfaceModifier Members

Description

SetFillColor

Sets the surface fill color.

GetFillColor

Retrieves the surface fill color.

SetBounds

Sets the surface's volume boundary structure.

SetBackground

Sets the surface modifier background surface.

GetBackground

Retrieves a pointer to the DXSurface used as a background.

SetCompositeOperation

Selects the method used for image compositing.

GetCompositeOperation

Retrieves the method used for image compositing.

SetForeground

Selects the DXSurface to use as a foreground.

GetForeground

Retrieves a pointer to the DXSurface used as a foreground.

SetOpacity

Sets the opacity of the foreground surface.

GetOpacity

Retrieves the opacity of the foreground surface.

SetLookup

Sets the interface to use for color lookup table operations on the foreground surface.

GetLookup

Retrieves the interface to the selected color lookup table.

SetFillColor

FUNCTION IDXSurfaceModifier_SetFillColor ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL prmColor AS DXSAMPLE _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[3] USING IDXSurfaceModifier_SetFillColor (pthis, prmColor) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetFillColor

FUNCTION IDXSurfaceModifier_GetFillColor ( _
  BYVAL pthis AS DWORD PTR _

, BYREF pColor AS DXSAMPLE _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[4] USING IDXSurfaceModifier_GetFillColor (pthis, pColor) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SetBounds

FUNCTION IDXSurfaceModifier_SetBounds ( _
  BYVAL pthis AS DWORD PTR _

, BYREF pBounds AS DXBNDS _

  ) AS LONG

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

END FUNCTION
 

SetBackground

FUNCTION IDXSurfaceModifier_SetBackground ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL pSurface AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[6] USING IDXSurfaceModifier_SetBackground (pthis, pSurface) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetBackground

FUNCTION IDXSurfaceModifier_GetBackground ( _
  BYVAL pthis AS DWORD PTR _

, BYREF ppSurface AS DWORD _

  ) AS LONG

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

END FUNCTION
 

SetCompositeOperation

FUNCTION IDXSurfaceModifier_SetCompositeOperation ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL CompOp AS LONG _

  ) AS LONG

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

END FUNCTION

GetCompositeOperation

FUNCTION IDXSurfaceModifier_GetCompositeOperation ( _
  BYVAL pthis AS DWORD PTR _

, BYREF pCompOp AS LONG _

  ) AS LONG

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

END FUNCTION
 

SetForeground

FUNCTION IDXSurfaceModifier_SetForeground ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL pSurface AS DWORD _

, BYVAL bTile AS LONG _

, BYREF pOrigin AS apiPOINT _

  ) AS LONG

LOCAL HRESULT AS LONG
CALL DWORD @@pthis[10] USING IDXSurfaceModifier_SetForeground (pthis, pSurface, bTile, pOrigin) TO HRESULT
FUNCTION = HRESULT

END FUNCTION
 

GetForeground

FUNCTION IDXSurfaceModifier_GetForeground ( _
  BYVAL pthis AS DWORD PTR _

, BYREF ppSurface AS DWORD _

, BYREF pbTile AS LONG _

, BYREF pOrigin AS apiPOINT _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[11] USING IDXSurfaceModifier_GetForeground (pthis, ppSurface, pbTile, pOrigin) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SetOpacity

FUNCTION IDXSurfaceModifier_SetOpacity ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL Opacity AS SINGLE _

  ) AS LONG

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

END FUNCTION
 

GetOpacity

FUNCTION IDXSurfaceModifier_GetOpacity ( _
  BYVAL pthis AS DWORD PTR _

, BYREF pOpacity AS SINGLE _

  ) AS LONG

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

END FUNCTION
 

GetLookup

FUNCTION IDXSurfaceModifier_GetLookup ( _
  BYVAL pthis AS DWORD PTR _

, BYREF ppLookupTable AS DWORD _

  ) AS LONG

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

END FUNCTION