NET:LavishVMAPI.Frame.TryLock

Overview

See Frame Locking.

FrameTryLock attempts to acquire a non-exclusive lock on the current frame, such that the frame will not complete until the lock is released via FrameUnlock. This also ensures that the host application (e.g. game) is not making modifications to relevant game objects. If the lock cannot be immediately acquired, for example due to the game currently processing a frame, or another thread acquiring an exclusive lock, the call fails and returns false.

There must be one unlock call per successful lock call.

Reference Library

Lavish.InnerSpace.dll

Fully Qualified Name

LavishVMAPI.Frame.FrameTryLock

• LavishVMAPI namespace
  • Frame class
    • FrameTryLock function

Declaration

static public bool FrameTryLock();

Parameters

None

Return Value

• bool

true if the lock was successfully acquired, false if not

See Also

• Frame Locking
• Inner Space .NET
• Lavish.InnerSpace.dll