CubeTexture.LockRectangle(Type,CubeMapFace,Int32,LockFlags,Int32[]) Method (Microsoft.DirectX.Direct3D)

  • Article

Locks a rectangle on a cube texture resource.

Definition

Visual Basic Public Function LockRectangle( _
    ByVal typeLock As TypeLeave Site, _
    ByVal faceType As CubeMapFace, _
    ByVal level As Integer, _
    ByVal flags As LockFlags, _
    ByVal ranks() As Integer _
) As ArrayLeave Site
C# public ArrayLeave Site LockRectangle(
    TypeLeave Site typeLock,
    CubeMapFace faceType,
    int level,
    LockFlags flags,
    int[] ranks
);
C++ public:
ArrayLeave Site^ LockRectangle(
    TypeLeave Site^ typeLock,
    CubeMapFace faceType,
    int level,
    LockFlags flags,
    array<int>^ ranks
);
JScript public function LockRectangle(
    typeLock : TypeLeave Site,
    faceType : CubeMapFace,
    level : int,
    flags : LockFlags,
    ranks : int[]
) : ArrayLeave Site;

Parameters

typeLock System.Type
A TypeLeave Site object that indicates the type of array data to return. This can be a value type or any type that contains only value types.
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.
ranks System.Int32[]
Array of 1 to 3 Int32Leave Site values that indicate the dimensions of the returning ArrayLeave Site.

Return Value

System.Array
An ArrayLeave Site 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.

See Also