Share via

Volume.LockBox(Box,LockFlags,LockedBox) Method (Microsoft.DirectX.Direct3D)

  • Article

Locks a box on a volume resource.

Definition

Visual Basic Public Function LockBox( _
    ByVal box As Box, _
    ByVal flags As LockFlags, _
    ByRef lockedVolume As LockedBox _
) As GraphicsStream
C# public GraphicsStream LockBox(
    Box box,
    LockFlags flags,
    out LockedBox lockedVolume
);
C++ public:
GraphicsStream^ LockBox(
    Box box,
    LockFlags flags,
    [Out] LockedBox% lockedVolume
);
JScript public function LockBox(
    box : Box,
    flags : LockFlags,
    lockedVolume : LockedBox
) : GraphicsStream;

Parameters

box Microsoft.DirectX.Direct3D.Box
A Box object that represents the box to lock.
flags Microsoft.DirectX.Direct3D.LockFlags
Combination of zero or more LockFlags that describe the type of lock to perform. See Remarks.
lockedVolume Microsoft.DirectX.Direct3D.LockedBox
A LockedBox object that describes the locked region.

Return Value

Microsoft.DirectX.GraphicsStream
A GraphicsStream that represents the locked box region.

Remarks

The valid lock flags for this method are:

For performance reasons, dirty regions are recorded only for level zero of a texture. Dirty regions are automatically recorded when Volume.LockBox is called without LockFlags.NoDirtyUpdate or LockFlags.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.