Skip to content

LiteFX

Namespaces

NameDescription
Graphics
Logging
Math
Rendering
meta Contains type traits and meta-programming features for compile-time evaluation.

Types

NameDescription
App The base class for an application.
AppBuilder Creates a new builder for an App.
AppVersion Contains the version of an App.
ArgumentNotInitializedException An exception that is thrown, if a provided non-optional argument was not initialized.
ArgumentOutOfRangeException An exception that is thrown, if a provided argument is not within the expected range.
Builder Describes an generic builder type.
CovariantIterator Wraps an iterator and returns covariants of type T of the iterated value.
Delegate Represents a handler for an Event, that is assigned a unique token when created, so that it can be identified later.
Enumerable An input range over another range, where the returned values of type T are covariants of the values stored by the underlying range.
Event A class that is used to declare an event, which a number of listeners can subscribe to.
EventArgs Base class for additional event arguments.
Exception The base class for exceptions thrown by the SDK.
IBackend The base class for an app backend.
IResource Provides access to a resource managed by the class.
InvalidArgumentException An exception that is thrown, if a provided argument is not valid.
PimplPtr A smart pointer that manages an implementation instance for a public interface class.
ResizeEventArgs Stores event arguments of a window resize event.
Resource Implements the IResource interface.
RuntimeException An exception that is thrown, if a requested operation could not be executed.
SharedObject Base class for an object that can be shared.
type_switch A switch that can be used to select a callable from a parameter type.

Type Aliases

NameDescription
Array Represents a dynamic array.
Dictionary Represents a dictionary that maps a key to a certain value.
Generator Describes an intermediate container for elements of type T.
Handle Represents a handle type.
Optional Represents an optional value.
Queue Represents a queue.
Ref Represents a copyable and assignable reference wrapper.
SharedPtr Represents a shared pointer, that expresses non-exclusive ownership.
Span Represents a view of an array.
String
StringView
Tuple Represents a tuple of multiple objects.
UniquePtr Represents a unique pointer, that expresses exclusive ownership.
Variant Represents a variant of objects.
WString
WStringView
WeakPtr Represents a weak pointer, that expresses a reference to a shared pointer instance.

Enums

Functions

NameDescription
Join
Narrow Converts an UTF-16 multi-byte encoded string into an UTF-8 representation.
WJoin
Widen Converts an UTF-8 single-byte encoded string into an UTF-16 representation.
asShared Transfers a unique pointer to a shared pointer. The unique pointer will be released during this process.
makeShared Creates a new shared pointer.
makeUnique Creates a new unique pointer.
operator""_hash Computes the FNVa hash for string.

Variables

Concepts

NameDescription
backend Concept that can be used to refer to backend implementations.
covariant_forward_iterator Evaluates, if an iterator of type TIterator iterates values that are covariant to TValue.
is_covariant Evaluates if a type TCovariant behaves covariant to a value type TValue. In this context, covariance is expressed as the type TCovariant can be assigned a value of type TValue or can be constructed from a value of TValue.

Using Namespace Directives

Name
Logging