Skip to content

Latest commit

 

History

History
126 lines (85 loc) · 4.65 KB

nf-d3d9-idirect3dcubetexture9-lockrect.md

File metadata and controls

126 lines (85 loc) · 4.65 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:d3d9.IDirect3DCubeTexture9.LockRect
IDirect3DCubeTexture9::LockRect (d3d9.h)
The IDirect3DCubeTexture9::LockRect method (d3d9.h) locks a rectangle on a cube texture resource.
1f5618d3-63b7-c0fc-9b6e-44b99c39650c
IDirect3DCubeTexture9 interface [Direct3D 9]
LockRect method
IDirect3DCubeTexture9.LockRect
IDirect3DCubeTexture9::LockRect
LockRect
LockRect method [Direct3D 9]
LockRect method [Direct3D 9]
IDirect3DCubeTexture9 interface
d3d9helper/IDirect3DCubeTexture9::LockRect
direct3d9.idirect3dcubetexture9__lockrect
direct3d9\idirect3dcubetexture9__lockrect.htm
direct3d9
VS|directx_sdk|~\idirect3dcubetexture9__lockrect.htm
08/10/2022
1f5618d3-63b7-c0fc-9b6e-44b99c39650c, IDirect3DCubeTexture9 interface [Direct3D 9],LockRect method, IDirect3DCubeTexture9.LockRect, IDirect3DCubeTexture9::LockRect, LockRect, LockRect method [Direct3D 9], LockRect method [Direct3D 9],IDirect3DCubeTexture9 interface, d3d9helper/IDirect3DCubeTexture9::LockRect, direct3d9.idirect3dcubetexture9__lockrect
d3d9.h
D3D9.h
Windows
D3D9.lib
Windows
19H1
IDirect3DCubeTexture9::LockRect
d3d9/IDirect3DCubeTexture9::LockRect
c++
APIRef
kbSyntax
COM
D3D9.lib
D3D9.dll
IDirect3DCubeTexture9.LockRect

IDirect3DCubeTexture9::LockRect

-description

Locks a rectangle on a cube texture resource.

-parameters

-param FaceType [in]

Type: D3DCUBEMAP_FACES

Member of the D3DCUBEMAP_FACES enumerated type, identifying a cube map face.

-param Level [in]

Type: UINT

Specifies a level of a mipmapped cube texture.

-param pLockedRect [out]

Type: D3DLOCKED_RECT*

Pointer to a D3DLOCKED_RECT structure, describing the region to lock.

-param pRect [in]

Type: const RECT*

Pointer to a rectangle to lock. Specified by a pointer to a RECT structure. Specifying NULL for this parameter expands the dirty region to cover the entire cube texture.

-param Flags [in]

Type: DWORD

Combination of zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are:

  • D3DLOCK_DISCARD
  • D3DLOCK_NO_DIRTY_UPDATE
  • D3DLOCK_NOSYSLOCK
  • D3DLOCK_READONLY
You may not specify a subrect when using D3DLOCK_DISCARD. For a description of the flags, see D3DLOCK.

-returns

Type: HRESULT

If the method succeeds, the return value is D3D_OK. D3DERR_INVALIDCALL is returned if one or more of the arguments is invalid.

-remarks

For performance reasons, dirty regions are only recorded for level zero of a texture. Dirty regions are automatically recorded when IDirect3DCubeTexture9::LockRect is called without D3DLOCK_NO_DIRTY_UPDATE or D3DLOCK_READONLY. See IDirect3DDevice9::UpdateTexture for more information.

Cube textures created with D3DPOOL_DEFAULT are not lockable. Cube textures created in video memory are lockable when created with USAGE_DYNAMIC.

The only lockable format for a depth-stencil texture is D3DFMT_D16_LOCKABLE.

-see-also

IDirect3DCubeTexture9

IDirect3DCubeTexture9::AddDirtyRect

IDirect3DCubeTexture9::GetLevelDesc

IDirect3DCubeTexture9::UnlockRect