ReleasePythonGil#

Fully qualified name: carb::scripting::ReleasePythonGil

Defined in carb/scripting/IPythonThreading.h

class ReleasePythonGil#

A scoped object that attempts to completely release the Python Global Interpreter Lock (GIL) if held by the current thread, allowing other threads to make progress in the Python interpreter.

This is akin to the current Python thread yielding as a co-routine would. Upon destruction of this object, the Python thread resumes and re-acquires the GIL.

If Python is not loaded into the process and initialized, this object has no effect. This is also safe to call on a thread that does not hold the GIL.

Public Functions

inline ReleasePythonGil()#

Constructor: Causes the current Python thread (if running in Python) to yield and release the GIL.

inline ~ReleasePythonGil()#

Destructor: Resumes the current Python thread (if previously yielded) and re-acquires the GIL.