IDirect3DIndexBuffer8::Lock

Locks a range of index data and obtains a pointer to the index buffer memory.

HRESULT Lock(
  UINT OffsetToLock,
  UINT SizeToLock,
  BYTE** ppbData,
  DWORD Flags
);

Parameters

OffsetToLock

[in] Offset into the index data to lock, in bytes. Lock the entire index buffer by specifying 0 for both parameters, SizeToLock and OffsetToLock.

SizeToLock

[in] Size of the index data to lock, in bytes. Lock the entire index buffer by specifying 0 for both parameters, SizeToLock and OffsetToLock.

ppbData

[out] Address of a pointer to an array of BYTE values, filled with the returned index data.

Flags

[in] A combination of zero or more locking flags, describing how the index buffer memory should be locked.

D3DLOCK_DISCARD

The application discards the entire index buffer. This enables Microsoft® Direct3D® to return a pointer to a new memory area so that the dynamic memory access (DMA) and rendering from the previous area do not stall.

D3DLOCK_NOOVERWRITE

Indicates that no indices that were referred to in drawing calls since the start of the frame or the last lock without this flag will be modified during the lock. This can enable optimizations when the application is only appending data to the index buffer.

D3DLOCK_NOSYSLOCK

The default behavior of a video memory lock is to reserve a system-wide critical section, guaranteeing that no display mode changes will occur for the duration of the lock. This flag causes the system-wide critical section not to be held for the duration of the lock.

The lock operation is slightly more expensive, but can enable the system to perform other duties, such as moving the mouse cursor. This flag is useful for long-duration locks, such as the lock of the back buffer for software rendering that would otherwise adversely affect system responsiveness.

D3DLOCK_READONLY

The application will not write to the buffer. This enables some optimization. D3DLOCK_READONLY cannot be specified with D3DLOCK_DISCARD; nor can it be specified on an index buffer created with D3DUSAGE_WRITEONLY.

Return Values

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value can be D3DERR_INVALIDCALL.

Remarks

When working with index buffers, you are allowed to make multiple lock calls. However, you must ensure that the number of lock calls match the number of unlock calls. DrawPrimitive calls will not succeed with any outstanding lock count on any currently set index buffer.

The D3DLOCK_DISCARD and D3DLOCK_NOOVERWRITE flags are valid only on buffers created with D3DUSAGE_DYNAMIC.

See Programming Tips for information on using D3DLOCK_DISCARD or D3DLOCK_NOOVERWRITE for the Flags parameter of the Lock method.

Requirements

  Header: Declared in D3d8.h.
  Import Library: Use D3d8.lib.

See Also

IDirect3DIndexBuffer8::Unlock