VolumeTexture.LockBox(Type,Int32,Box,LockFlags,LockedBox,Int32[]) Method (Microsoft.DirectX.Direct3D)
Locks a box on a volume texture resource.
Definition
Visual Basic Public Function LockBox( _
ByVal typeLock As Type, _
ByVal level As Integer, _
ByVal box As Box, _
ByVal flags As LockFlags, _
ByRef lockedVolume As LockedBox, _
ByVal ranks() As Integer _
) As ArrayC# public Array
Type
int level,
Box box,
LockFlags flags,
out LockedBox lockedVolume,
int[] ranks
);C++ public:
Array
Type
int level,
Box box,
LockFlags flags,
[Out] LockedBox% lockedVolume,
array<int>^ ranks
);JScript public function LockBox(
typeLock : Type
level : int,
box : Box,
flags : LockFlags,
lockedVolume : LockedBox,
ranks : int[]
) : Array
Parameters
typeLock System.Type
A Typelevel 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.lockedVolume Microsoft.DirectX.Direct3D.LockedBox
A LockedBox structure that describes the locked region.ranks System.Int32[]
Array of one to three Int32
Return Value
System.Array
An Array
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
The method call is invalid. For example, a method's parameter might contain an invalid value.
See Also