CubeTexture.LockRectangle Method

Language:

Locks a rectangle on a cube texture resource.

Definition

Visual Basic Public Function LockRectangle( _
    ByVal faceType As CubeMapFace, _
    ByVal level As Integer, _
    ByVal flags As LockFlags, _
    ByRef pitch As Integer _
) As GraphicsStream

C# public GraphicsStream LockRectangle(
    CubeMapFace faceType,
    int level,
    LockFlags flags,
    out int pitch
);

C++ public:
GraphicsStream^ LockRectangle(
    CubeMapFace faceType,
    int level,
    LockFlags flags,
    [Out] int% pitch
);

JScript public function LockRectangle(
    faceType : CubeMapFace,
    level : int,
    flags : LockFlags,
    pitch : int
) : GraphicsStream;

Visual Basic	Public Function LockRectangle( _ ByVal faceType As CubeMapFace, _ ByVal level As Integer, _ ByVal flags As LockFlags, _ ByRef pitch As Integer _ ) As GraphicsStream
C#	public GraphicsStream LockRectangle( CubeMapFace faceType, int level, LockFlags flags, out int pitch );
C++	public: GraphicsStream^ LockRectangle( CubeMapFace faceType, int level, LockFlags flags, [Out] int% pitch );
JScript	public function LockRectangle( faceType : CubeMapFace, level : int, flags : LockFlags, pitch : int ) : GraphicsStream;

Parameters

faceType Microsoft.DirectX.Direct3D.CubeMapFace
Member of the CubeMapFace enumerated type that identifies a cube map face.

level System.Int32
Level of a cube texture.

flags Microsoft.DirectX.Direct3D.LockFlags
Zero or more LockFlags enumerated values that describe the type of lock to perform.

pitch System.Int32
Pitch of the returning data.

Return Value

Microsoft.DirectX.GraphicsStream
A GraphicsStream object that represents the locked rectangle.

Remarks

For performance reasons, dirty regions are recorded only for level 0 of a texture. Dirty regions are automatically recorded when CubeTexture.LockRectangle is called without NoDirtyUpdate or ReadOnly. For more information, see Device.UpdateTexture.

Cube textures created with Default are not lockable. Cube textures created in video memory are lockable when created with Usage.Dynamic. For more information about usages, see Dynamic.

The only lockable format for a depth stencil texture is Format.D16Lockable.

faceType	Microsoft.DirectX.Direct3D.CubeMapFace Member of the CubeMapFace enumerated type that identifies a cube map face.
level	System.Int32 Level of a cube texture.
flags	Microsoft.DirectX.Direct3D.LockFlags Zero or more LockFlags enumerated values that describe the type of lock to perform.
pitch	System.Int32 Pitch of the returning data.