IDirect3DSurface9::GetContainer method

Provides access to the parent cube texture or texture (mipmap) object, if this surface is a child level of a cube texture or a mipmap. This method can also provide access to the parent swap chain if the surface is a back-buffer child.

Syntax


HRESULT GetContainer(
  [in]  REFIID riid,
  [out] void   **ppContainer
);

Parameters

riid [in]

Type: REFIID

Reference identifier of the container being requested.

ppContainer [out]

Type: void**

Address of a pointer to fill with the container pointer if the query succeeds. See Remarks.

Return value

Type: HRESULT

If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL.

Remarks

If the surface is created using CreateRenderTarget or CreateOffscreenPlainSurface or CreateDepthStencilSurface, the surface is considered stand alone. In this case, GetContainer will return the Direct3D device used to create the surface.

If the call succeeds, the reference count of the container is increased by one.

Here's an example getting the parent texture of a mip surface.



    
// Assumes pSurface is a valid IDirect3DSurface9 pointer
void *pContainer = NULL;
IDirect3DTexture9 *pTexture = NULL;
HRESULT hr = pSurface->GetContainer(IID_IDirect3DTexture9, &pContainer);
if (SUCCEEDED(hr) && pContainer)
{
    pTexture = (IDirect3DTexture9 *)pContainer;
}


Requirements

Header

D3D9.h

Library

D3D9.lib

See also

IDirect3DSurface9

 

 

Show: