Uncategorized
Symbols that have no @defgroup or @addtogroup scope assigned.
Classes
-
LockingPolicy— Policy that allows the calls its used in to pick between no locking and mutex locking through a template parameter. -
ScopedLock— Scoped lock that provides RAII-style locking and accepts both a normal mutex and a locking policy as input. -
WaitGroup— Provides an easy way to wait for N operations to complete executing. -
SignalEvent— Event that can be waited on until signalled. -
detail::RunOnNewThreadHelper -
SchedulerTicket— Tickets allow you to schedule sequential execution of tasks. -
SchedulerTicketQueue— Queue that hands out scheduler tickets. -
SingleConsumerQueue— Allows you to queue sequential commands safely from any thread/fiber, which are then processed by a single worker thread/fiber. -
ThreadDefaultPolicy— Default thread policy for the framework. -
render::TrackedGpuBufferSuballocation— Tracked GPU buffer suballocation that automatically releases itself when destroyed. -
render::TransientGpuBufferPool— Pool allocator for GPU buffer suballocations. -
render::GpuBufferPool— GPU buffer pool with manual or automatic lifetime management. -
ID6JointImplementation— Low-level interface for a joint used by the D6Joint component. -
render::DecalProxy— Render-thread representation of a decal, stored in packed arrays in DecalObjectStorageBase. -
IHingeJointImplementation— Low-level interface for a joint used by the HingeJoint component. -
MaterialBase— Material that controls how objects are rendered. -
TMaterial— Material that controls how objects are rendered. -
TShader— Templated version of Shader used for implementing both main and render thread counterparts. -
Gamepad— Represents a single hardware gamepad. -
Keyboard— Represents a single hardware keyboard. -
Mouse— Represents a single hardware mouse. -
GpuFrameCapture— Allows capturing a range of GPU commands for analysis by external tools (such as RenderDoc, nSight). -
render::GpuResourcePool— Contains a pool of textures and buffers meant to accommodate reuse of such resources for the main purpose of using them as write targets on the GPU. -
TScriptObjectWrapper— Provides common functionality required by specializations of ScriptObjectWrapper, including a meta-data object to store information about the type, ability to bind the script object wrapper to the script object, and retrieve the wrapper from the script object -
ScriptScriptObject— Script object wrapper for ScriptObject. (Script prefix used as standard for script object wrappers, wrapping ScriptObject. -
ScriptCategory— Interop class between C++ & CLR for the Category attribute. -
ScriptOrder— Interop class between C++ & CLR for the Order attribute. -
ScriptRange— Interop class between C++ & CLR for the Range attribute. -
ScriptStep— Interop class between C++ & CLR for Step attribute. -
ScriptUndoableOperationWrapperBase— Provides a root base class to use for TScriptNonReflectableWrapper implementations. -
ScriptUndoableOperation— Extends TScriptObjectWrapper by providing functionality required for types not deriving from IReflectable that may be passed along as a shared pointer. -
ScriptGUIRenderableWrapperBase— Provides a base class for all script object wrappers that wrap a GUIElement object passed as a pointer. -
ScriptGUIRenderable— Extends TScriptObjectWrapper by providing functionality required for types deriving from GUIElement passed along as a pointer. -
ScriptGUIInteractableWrapperBase— Provides a base class for all script object wrappers that wrap a GUIElement object passed as a pointer. -
ScriptGUIInteractable— Extends TScriptObjectWrapper by providing functionality required for types deriving from GUIElement passed along as a pointer. -
ScriptGUIElement— Extends TScriptObjectWrapper by providing functionality required for types deriving from GUIElement passed along as a pointer.
Structs
-
EnumClassHash— Hash for enum types, to be used instead of std::hash <T > when T is an enum. -
NativePtr— "Smart" pointer that is not smart. -
CrashHandlerSettings— Struct for holding crash handler settings -
SchedulerTicketData— Linked list entry storing information about one ticket, and links a ticket to its previous/next ticket. -
SchedulerTicketQueueData— Data shared between all tickets for a particular queue. -
SingleConsumerQueue::QueuedCommand— Command queue for execution. -
RenderThreadType -
CoreVariant -
CoreVariantHandle -
LogCategoryLogRenderThread— Templated base class for a category with some particular default verbosity. -
LogCategoryLogRenderer— Templated base class for a category with some particular default verbosity. -
LogCategoryLogScene— Templated base class for a category with some particular default verbosity. -
LogCategoryLogPhysics— Templated base class for a category with some particular default verbosity. -
LogCategoryLogAudio— Templated base class for a category with some particular default verbosity. -
LogCategoryLogRenderBackend— Templated base class for a category with some particular default verbosity. -
LogCategoryLogBSLCompiler— Templated base class for a category with some particular default verbosity. -
LogCategoryLogParticles— Templated base class for a category with some particular default verbosity. -
LogCategoryLogResources— Templated base class for a category with some particular default verbosity. -
LogCategoryLogFBXImporter— Templated base class for a category with some particular default verbosity. -
LogCategoryLogPixelUtility— Templated base class for a category with some particular default verbosity. -
LogCategoryLogTexture— Templated base class for a category with some particular default verbosity. -
LogCategoryLogMesh— Templated base class for a category with some particular default verbosity. -
LogCategoryLogGUI— Templated base class for a category with some particular default verbosity. -
LogCategoryLogProfiler— Templated base class for a category with some particular default verbosity. -
LogCategoryLogMaterial— Templated base class for a category with some particular default verbosity. -
LogCategoryLogFreeImageImporter— Templated base class for a category with some particular default verbosity. -
LogCategoryLogScript— Templated base class for a category with some particular default verbosity. -
LogCategoryLogImporter— Templated base class for a category with some particular default verbosity. -
LogCategoryLogNetwork— Templated base class for a category with some particular default verbosity. -
LogCategoryLogInput— Templated base class for a category with some particular default verbosity. -
RenderProxyTypeHelper— Returns a render proxy type associated with the provided type. -
MaterialBase::StructData— Data used to describe a structure defined within a shader. -
PerSceneFrameData— Contains various data evaluated by external systems on a per-frame basis, for a particular scene. -
PerFrameData— Contains per-frame data for all scenes. -
ShaderCreateInformation— Descriptor structure used for initialization of a Shader. -
GUIRenderElementHelper— Helper class used for populating GUIRenderElement information from Sprite objects. -
GUIRenderElementHelper::SpriteInfo— Contains the sprite to generate render element data for, as well as additional data not provided in the sprite itself. -
render::PooledRenderTexture— Contains data about a single render texture in the GPU resource pool. -
render::PooledStorageBuffer— Contains data about a single storage buffer in the GPU resource pool. -
render::PooledRenderTextureCreateInformation— Structure used for creating a new pooled render texture. -
render::POOLED_STORAGE_BUFFER_DESC— Structure used for describing a pooled storage buffer. -
FilmGrainSettings— Settings that control the film grain effect. -
ShadowSettings— Various options that control shadow rendering for a specific view. -
InitializeScriptObjectWrapperOnLoadTime— Ensures that ScriptObjectWrapper types are initialized on application load. -
RawBackupData— Contains backup data in the form of a raw memory buffer. -
LogCategoryLogEditor— Templated base class for a category with some particular default verbosity.
Enums
-
ThreadSafetyPolicy— Controls thread safety in variety of cases. -
TypeID_Utility -
LogVerbosity— Represents verbosity level at which a specific log message will be displayed. -
SignalEvent::Mode -
TypeID_Core -
SerializationFlags— Flags that are provided to the serialization system to control serialization/deserialization. -
MonoPrimitiveType— A list of all valid Mono primitive types. -
MonoMemberVisibility— Returns the level of member visibility in the class. -
TypeID_bsfScript -
BuiltinResourceType— Types of resources accessible from script code. -
CodeEditorType— Recognized types of external code editors. -
TypeID_BansheeEditor— Type IDs used by the RTTI system for the editor library.
Free functions
B3DIsCompleteImplementation
std::true_type B3DIsCompleteImplementation(T *)
B3DIsCompleteImplementation
std::false_type B3DIsCompleteImplementation(...)
B3DMakeUniqueFromExisting
UPtr<Type, AllocatorTag, Delete> B3DMakeUniqueFromExisting(Type *data, Delete del = Delete())
Create a new unique pointer from a previously constructed object.
Pointer specific data will be allocated using the provided allocator category.
B3DMakeUnique
UPtr<Type, AllocatorTag, Delete> B3DMakeUnique(Args &&...args)
Create a new unique pointer using a custom allocator category.
B3DIsWeakUnassigned
bool B3DIsWeakUnassigned(const WeakSPtr<Type> &pointer)
Returns true if the weak pointer is not assigned.
Will return false if the pointer was assigned but has since expired.
RunBlockingCallAsYieldable
auto RunBlockingCallAsYieldable(F &&f, Args &&...args) -> decltype(f(args...))
Runs the provided function on its own thread and allows the calling fiber to yield and let other work happen.
Useful if you expect the provided function to block for a longer period of time, but still want to let the current thread continue doing work.
DeferredCall
void DeferredCall(std::function<void ()> callback)
Defers function execution until the next frame.
If this function is called within another deferred call, then it will be executed the same frame, but only after all existing deferred calls are done.
- callback
- The callback.
IsValid
bool IsValid(const SPtr<T> &object)
Checks if the object is not null.
IsValid
bool IsValid(const TResourceHandle<T> &object)
Checks if the object is not null.
IsValid
bool IsValid(const TGameObjectHandle<T> &object)
Checks if the object is not null.
B3DGetRenderProxy
SPtr<CoreVariantType<Type, true>> B3DGetRenderProxy(Type *const object)
Returns associated render proxy object, or null if the object is null or has no render proxy.
B3DGetRenderProxy
SPtr<CoreVariantType<Type, true>> B3DGetRenderProxy(const SPtr<Type> &object)
Returns associated render proxy object, or null if the object is null or has no render proxy.
B3DGetRenderProxy
SPtr<CoreVariantType<Type, true>> B3DGetRenderProxy(const SPtr<const Type> &object)
Returns associated render proxy object, or null if the object is null or has no render proxy.
B3DGetRenderProxy
WeakSPtr<CoreVariantType<Type, true>> B3DGetRenderProxy(const WeakSPtr<Type> &object)
Returns associated render proxy object, or null if the object is null or has no render proxy.
B3DGetRenderProxy
WeakSPtr<CoreVariantType<Type, true>> B3DGetRenderProxy(const WeakSPtr<const Type> &object)
Returns associated render proxy object, or null if the object is null or has no render proxy.
B3DGetRenderProxy
SPtr<CoreVariantType<Type, true>> B3DGetRenderProxy(const TResourceHandle<Type> &object)
Returns associated render proxy object, or null if the object is null or has no render proxy.
B3DGetRenderProxy
SPtr<CoreVariantType<Type, true>> B3DGetRenderProxy(const TGameObjectHandle<Type> &object)
Returns associated render proxy object, or null if the object is null or has no render proxy.
GetGpuResourcePool
GpuResourcePool &GetGpuResourcePool()
Provides easy access to the GpuResourcePool.
Internal
Symbols intended for engine-internal use. Not part of the public API.
Structs
-
internal::TFNVHashParameters -
render::TransientGpuBufferPool::SuballocationEntry— Entry in the suballocation pool with intrusive free-list link. -
render::GpuBufferPool::SuballocationEntry— Entry in the suballocation pool with intrusive free-list link, tracking free suballocations. -
render::GpuBufferPool::BufferEntry— Entry for a GPU buffer.