Microsoft DirectX 8.1 (Visual Basic)

Direct3DVolume8.LockBox

Locks a box on a volume.

object.LockBox( _ 
    LockedBox As D3DLOCKED_BOX, _ 
    Box As D3DBOX, _ 
    Flags As Long)

Parts

object
Object expression that resolves to a Direct3DVolume8 object.
LockedBox
A D3DLOCKED_BOX type, describing the locked region.
Box
Box to lock. Specified by a D3DBOX type. Specifying ByVal 0 locks the entire volume.
Flags
A combination of zero or more valid locking flags defined by the CONST_D3DLOCKFLAGS enumeration, describing the type of lock to perform.

Error Codes

If the method fails, an error is raised and Err.Number can be set to D3DERR_INVALIDCALL.

For information on trapping errors, see the Microsoft® Visual Basic® Error Handling topic.

Remarks

For performance reasons, dirty regions are only recorded for level zero of a texture. Dirty regions are automatically recorded when LockBox is called without D3DLOCK_NO_DIRTY_UPDATE or D3DLOCK_READONLY. See Direct3DDevice8.UpdateTexture for more information.

See Also

Direct3DVolume8.UnlockBox