IDXARGBReadPtr Interface

IID_IDXARGBReadPtr

{EAAAC2D6-C290-11d1-905D-00C04FD9189D}

The IDXARGBReadPtr interface enables Microsoft DirectX Transform objects to gain read-only access to samples contained in a DXSurface object.

MSDN Documentation: IDXARGBReadPtr Interface
 

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IDXARGBReadPtr Members

Description

GetSurface

Retrieves a pointer to the parent DXSurface.

GetNativeType

Retrieves the native underlying pixel format of a DXSurface.

Move

Moves the sample pointer along the x-axis relative to its current position.

MoveToRow

Moves the sample pointer to an absolute row along the y-axis and resets the x-axis position to zero.

MoveToXY

Moves the sample pointer to an absolute position.

MoveAndGetRunInfo

Moves the sample pointer to a specified row and retrieves a pointer to the run information associated with that row.

Unpack

Unpacks the specified number of samples into the supplied buffer in ARGB32 pixel format. This method can only unpack a single row. Use IDXARGBReadPtr::UnpackRect to unpack multiple rows.

UnpackPreMult

Unpacks the specified number of samples into the supplied buffer in alpha-premultiplied PMARGB32 pixel format. This method only unpacks a single row. Use IDXARGBReadPtr::UnpackRect to unpack multiple rows.

UnpackRect

Unpacks a subsection of source samples defined by a rectangle structure and advances the horizontal position of the read pointer. Use to unpack multiple rows.

GetSurface

FUNCTION IDXARGBReadPtr_GetSurface ( _
  BYVAL pthis AS DWORD PTR _
, BYREF riid AS GUID _

, BYREF ppSurface AS DWORD _
  ) AS LONG

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

END FUNCTION
 

GetNativeType

FUNCTION IDXARGBReadPtr_GetNativeType ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pInfo AS DXNATIVETYPEINFO _
  ) AS LONG

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

END FUNCTION
 

Move

SUB IDXARGBReadPtr_Move ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL cSamples AS LONG _
  )

  CALL DWORD @@pthis[5] USING IDXARGBReadPtr_Move (pthis, cSamples)
 

END SUB
 

MoveToRow

SUB IDXARGBReadPtr_MoveToRow ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL y AS DWORD _
  )

  CALL DWORD @@pthis[6] USING IDXARGBReadPtr_MoveToRow (pthis, y)
 

END SUB
 

MoveToXY

SUB IDXARGBReadPtr_MoveToXY ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL x AS DWORD _
, BYVAL y AS DWORD _
  )
  CALL DWORD @@pthis[7] USING IDXARGBReadPtr_MoveToXY (pthis, x, y)
 

END SUB
 

MoveAndGetRunInfo

FUNCTION IDXARGBReadPtr_MoveAndGetRunInfo ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL Row AS DWORD _
, BYREF ppInfo AS DXRUNINFO _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[8] USING IDXARGBReadPtr_MoveAndGetRunInfo (pthis, Row, ppInfo) TO HRESULT
  FUNCTION = HRESULT
 

END FUNCTION
 

Unpack

FUNCTION IDXARGBReadPtr_Unpack ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pSamples AS DWORD _
, BYVAL cSamples AS DWORD _
, BYVAL bMove AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[9] USING IDXARGBReadPtr_Unpack (pthis, pSamples, cSamples, bMove) TO HRESULT
  FUNCTION = HRESULT
 

END FUNCTION
 

UnpackPremult

FUNCTION IDXARGBReadPtr_UnpackPremult ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pSamples AS DWORD _
, BYVAL cSamples AS DWORD _
, BYVAL bMove AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[10] USING IDXARGBReadPtr_UnpackPremult (pthis, pSamples, cSamples, bMove) TO HRESULT
  FUNCTION = HRESULT
 

END FUNCTION
 

UnpackRect

FUNCTION IDXARGBReadPtr_UnpackRect ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pRectDesc AS DXPACKEDRECTDESC _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[11] USING IDXARGBReadPtr_UnpackRect (pthis, pRectDesc) TO HRESULT
  FUNCTION = HRESULT
 

END FUNCTION