Direct3DSurface8.LockRect

Locks a rectangle on a surface.

object.LockRect( _ 
    LockedRect As D3DLOCKED_RECT, _ 
    RECT As Any, _ 
    Flags As Long)

Parts

object

Object expression that resolves to a Direct3DSurface8 object.

LockedRect

A D3DLOCKED_RECT type, describing the locked region.

RECT

Rectangle to lock. Specified by a RECT type, or ByVal 0 to expand the dirty region to cover the entire surface.

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

A multisample backbuffer cannot be locked.

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

See Also

Direct3DSurface8.UnlockRect