VolumeTexture.LockBox(Type,Int32,Box,LockFlags,Int32[]) Method (Microsoft.DirectX.Direct3D)

Locks a box on a volume texture resource.

Definition

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

Parameters

typeLock System.Type
A TypeLeave Site object that indicates the type of data to return. This can be a value type or any type that contains only value types.
level System.Int32
Value that specifies a level of the texture resource to lock.
box Microsoft.DirectX.Direct3D.Box
A Box structure that indicates the region to lock. Omitting this parameter locks the entire volume level.
flags Microsoft.DirectX.Direct3D.LockFlags
Zero or more locking flags that describe the type of lock to perform. For this method, the valid flags are Discard, NoDirtyUpdate, NoSystemLock, and ReadOnly. For a description of the flags, see LockFlags.
ranks System.Int32[]
Array of one to three Int32Leave Site values that indicate the dimensions of the returning ArrayLeave Site.

Return Value

System.Array
An ArrayLeave Site object that describes the locked region.

Remarks

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

Exceptions

InvalidCallException

The method call is invalid. For example, a method's parameter might contain an invalid value.

See Also