IDirect3DVolumeTexture9 Interface

' ****************************************************************************************
' IDirect3DVolumeTexture9 interface
' $IID_IDirect3DVolumeTexture9 = GUID$("{2518526C-E789-4111-A7B9-47EF328D13E6}")
' ****************************************************************************************

' ****************************************************************************************
' Applications use the methods of the IDirect3DVolumeTexture9 interface to manipulate a volume
' texture resource.
' The IDirect3DVolumeTexture9 interface can be obtained by calling the IDirect3DDevice9::CreateVolumeTexture
' method or one of the D3DXCreateVolumeTexturexxx functions.
' This interface inherits additional functionality from the IDirect3DBaseTexture9 interface.
' ****************************************************************************************

' ****************************************************************************************
'DECLARE_INTERFACE_(IDirect3DVolumeTexture9, IDirect3DBaseTexture9)
'{
'    /*** IUnknown methods ***/
'  0.  STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE;
'  1.  STDMETHOD_(ULONG,AddRef)(THIS) PURE;
'  2.  STDMETHOD_(ULONG,Release)(THIS) PURE;

'    /*** IDirect3DBaseTexture9 methods ***/
'  3.  STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE;
'  4.  STDMETHOD(SetPrivateData)(THIS_ REFGUID refguid,CONST void* pData,DWORD SizeOfData,DWORD Flags) PURE;
'  5.  STDMETHOD(GetPrivateData)(THIS_ REFGUID refguid,void* pData,DWORD* pSizeOfData) PURE;
'  6.  STDMETHOD(FreePrivateData)(THIS_ REFGUID refguid) PURE;
'  7.  STDMETHOD_(DWORD, SetPriority)(THIS_ DWORD PriorityNew) PURE;
'  8.  STDMETHOD_(DWORD, GetPriority)(THIS) PURE;
'  9.  STDMETHOD_(void, PreLoad)(THIS) PURE;
' 10.  STDMETHOD_(D3DRESOURCETYPE, GetType)(THIS) PURE;

'    /*** IDirect3DResource9 methods ***/
' 11.  STDMETHOD_(DWORD, SetLOD)(THIS_ DWORD LODNew) PURE;
' 12.  STDMETHOD_(DWORD, GetLOD)(THIS) PURE;
' 13.  STDMETHOD_(DWORD, GetLevelCount)(THIS) PURE;
' 14.  STDMETHOD(SetAutoGenFilterType)(THIS_ D3DTEXTUREFILTERTYPE FilterType) PURE;
' 15.  STDMETHOD_(D3DTEXTUREFILTERTYPE, GetAutoGenFilterType)(THIS) PURE;
' 16.  STDMETHOD_(void, GenerateMipSubLevels)(THIS) PURE;

'    /*** IDirect3DVolumeTexture9 methods ***/
' 17.  STDMETHOD(GetLevelDesc)(THIS_ UINT Level,D3DVOLUME_DESC *pDesc) PURE;
' 18.  STDMETHOD(GetVolumeLevel)(THIS_ UINT Level,IDirect3DVolume9** ppVolumeLevel) PURE;
' 19.  STDMETHOD(LockBox)(THIS_ UINT Level,D3DLOCKED_BOX* pLockedVolume,CONST D3DBOX* pBox,DWORD Flags) PURE;
' 20.  STDMETHOD(UnlockBox)(THIS_ UINT Level) PURE;
' 21.  STDMETHOD(AddDirtyBox)(THIS_ CONST D3DBOX* pDirtyBox) PURE;
'};
' ****************************************************************************************

' ****************************************************************************************
' GetLevelDesc method
' Retrieves a level description of a volume texture resource.
' HRESULT GetLevelDesc(
'   UINT Level,
'   D3DVOLUME_DESC * pDesc
' );
' ****************************************************************************************
FUNCTION IDirect3DVolumeTexture9_GetLevelDesc ALIAS "IDirect3DVolumeTexture9_GetLevelDesc" ( _
    BYVAL pthis AS DWORD PTR, BYVAL Level AS DWORD, BYREF pDesc AS D3DVOLUME_DESC) EXPORT AS LONG

    LOCAL HRESULT AS LONG
    IF pthis = %NULL THEN FUNCTION = %E_POINTER : EXIT FUNCTION
    CALL DWORD @@pthis[17] USING IDirect3DVolumeTexture9_GetLevelDesc(pthis, Level, pDesc) TO HRESULT
    FUNCTION = HRESULT

END FUNCTION
' ****************************************************************************************

' ****************************************************************************************
' GetVolumeLevel method
' Retrieves the specified volume texture level.
' HRESULT GetVolumeLevel(
'   UINT Level,
'   IDirect3DVolume9 ** ppVolumeLevel
' );
' ****************************************************************************************
FUNCTION IDirect3DVolumeTexture9_GetVolumeLevel ALIAS "IDirect3DVolumeTexture9_GetVolumeLevel" ( _
    BYVAL pthis AS DWORD PTR, BYVAL Level AS DWORD, BYREF ppVolumeLevel AS DWORD) EXPORT AS LONG

    LOCAL HRESULT AS LONG
    IF pthis = %NULL THEN FUNCTION = %E_POINTER : EXIT FUNCTION
    CALL DWORD @@pthis[18] USING IDirect3DVolumeTexture9_GetVolumeLevel(pthis, Level, ppVolumeLevel) TO HRESULT
    FUNCTION = HRESULT

END FUNCTION
' ****************************************************************************************

' ****************************************************************************************
' LockBox method
' Locks a box on a volume texture resource.
' HRESULT LockBox(
'   UINT Level,
'   D3DLOCKED_BOX * pLockedVolume,
'   CONST D3DBOX * pBox,
'   DWORD Flags
' );
' ****************************************************************************************
FUNCTION IDirect3DVolumeTexture9_LockBox ALIAS "IDirect3DVolumeTexture9_LockBox" ( _
    BYVAL pthis AS DWORD PTR, BYREF pLockedVolume AS D3DLOCKED_BOX, _
    BYREF pBox AS D3DBOX, BYVAL Flags AS DWORD) EXPORT AS LONG

    LOCAL HRESULT AS LONG
    IF pthis = %NULL THEN FUNCTION = %E_POINTER : EXIT FUNCTION
    CALL DWORD @@pthis[19] USING IDirect3DVolumeTexture9_LockBox(pthis, pLockedVolume, pBox, Flags) TO HRESULT
    FUNCTION = HRESULT

END FUNCTION
' ****************************************************************************************

' ****************************************************************************************
' UnlockBox method
' Unlocks a box on a volume texture resource.
' HRESULT UnlockBox(
'   UINT Level
' );
' ****************************************************************************************
FUNCTION IDirect3DVolumeTexture9_UnlockBox ALIAS "IDirect3DVolumeTexture9_UnlockBox" (BYVAL pthis AS DWORD PTR) EXPORT AS LONG

    LOCAL HRESULT AS LONG
    IF pthis = %NULL THEN FUNCTION = %E_POINTER : EXIT FUNCTION
    CALL DWORD @@pthis[20] USING IDirect3DVolumeTexture9_UnlockBox(pthis) TO HRESULT
    FUNCTION = HRESULT

END FUNCTION
' ****************************************************************************************

' ****************************************************************************************
' AddDirtyBox method
' Adds a dirty region to a volume texture resource.
' HRESULT AddDirtyBox(
'   CONST D3DBOX * pDirtyBox
' );
' ****************************************************************************************
FUNCTION IDirect3DVolumeTexture9_AddDirtyBox ALIAS "IDirect3DVolumeTexture9_AddDirtyBox" ( _
    BYVAL pthis AS DWORD PTR, BYREF pDirtyBox AS D3DBOX) EXPORT AS LONG

    LOCAL HRESULT AS LONG
    IF pthis = %NULL THEN FUNCTION = %E_POINTER : EXIT FUNCTION
    CALL DWORD @@pthis[21] USING IDirect3DVolumeTexture9_AddDirtyBox(pthis, pDirtyBox) TO HRESULT
    FUNCTION = HRESULT

END FUNCTION
' ****************************************************************************************