nCine namespace

Namespaces

namespace Backends

Platform-specific backends.

namespace Primitives

Primitives.

namespace RHI

Render Hardware Interface — compile-time-selectable graphics backend abstraction.

Classes

class AccelerometerEvent

Accelerometer sensor reading.

class ALAudioDevice

OpenAL implementation of IAudioDevice.

class AndroidApplication

Main entry point and handler for Android applications.

class AnimatedSprite

Textured sprite that cycles through one or more frame animations.

class AppConfiguration

Initialization settings for an nCine application.

class Application

Base class for the main entry point of an nCine application.

class AudioBuffer

Fully decoded OpenAL audio buffer.

class AudioBufferPlayer

Plays back a fully decoded AudioBuffer.

class AudioLoaderMpt

Audio loader for tracker module formats, backed by libopenmpt.

class AudioLoaderOgg

Audio loader for the Ogg Vorbis format, backed by libvorbis.

class AudioLoaderWav

Audio loader for the WAVE (.wav) format.

class AudioReaderMpt

Audio reader for tracker module formats, backed by libopenmpt.

class AudioReaderOgg

Audio reader for the Ogg Vorbis format, backed by libvorbis.

class AudioReaderWav

Audio reader for the WAVE (.wav) format.

class AudioStream

Streams audio decoded on the fly into a rotating set of OpenAL buffers.

class AudioStreamPlayer

Plays back an AudioStream decoded on the fly.

class Barrier

Barrier for thread synchronization.

class BaseSprite

Base class for textured sprites.

class BinaryShaderCache

Caches compiled OpenGL shader programs in binary form on disk.

class BitArray

Dynamically allocated array of bits.

class BitArrayIndex

Proxy referring to a single bit of a BitArray.

template<class T>

class BitSet

Fixed-size sequence of bits backed by an unsigned integer.

class Camera

Provides the projection and view matrices used by shaders.

class Clock

High-resolution monotonic system clock.

class ColorAffector

Affector that animates the color of a particle.

class CondVariable

Condition variable for thread synchronization.

class DisplayMode

Describes the pixel format and buffering properties of a display surface.

class DrawableNode

Base class for scene nodes that can be drawn through the render queue.

template<class K>

class FNV1aHashFunc

Fowler-Noll-Vo (FNV-1a) hash function.

class FrameTimer

Tracks per-frame timing and computes the average FPS and frame time multiplier.

class Geometry

Contains the vertex and index buffer data for a drawable node.

class GfxCapabilities

Stores and retrieves runtime OpenGL device capabilities.

struct HatState

Bit flags describing the direction of a joystick hat (D-pad).

class I18n

Provides internationalization and translation support.

class IAppEventHandler

Interface for handling nCine application lifecycle and frame events.

class IAudioDevice

Interface for an audio device backend.

class IAudioLoader

Interface for an audio loader.

class IAudioPlayer

Interface for an audio player.

class IAudioReader

Interface for an audio reader.

class IDebugOverlay

Interface for an on-screen debug overlay.

class IGfxCapabilities

Interface to query runtime OpenGL device capabilities.

class IGfxDevice

Represents the interface to the graphics device where everything is rendered.

class IInputEventHandler

Interface for handling input events from keyboard, touch screen, mouse, accelerometer and joysticks.

class IInputManager

Interface for querying input state and dispatching input events.

class ImGuiDebugOverlay

Debug overlay implemented with the ImGui interface.

class ImGuiDrawing

Handles ImGui drawing.

class ITextureLoader

Texture loader interface class.

class IThreadCommand

Thread pool command interface.

class IThreadPool

Thread pool interface.

class JoyAxisEvent

Joystick axis event.

class JoyButtonEvent

Joystick button event.

class JoyConnectionEvent

Joystick connection or disconnection event.

class JoyHatEvent

Joystick hat event.

class JoyMappedAxisEvent

Mapped joystick axis event.

class JoyMappedButtonEvent

Mapped joystick button event.

class JoyMappedState

Current state of a joystick translated through its mapping into unified buttons and axes.

class JoyMapping

Translation layer that maps raw gamepad and joystick inputs to a unified layout.

class JoystickGuid

Parsed 16-byte GUID that identifies a joystick model.

class JoystickState

Current raw state of a joystick.

class KeyboardEvent

Keyboard key event.

class KeyboardState

Current state of the keyboard.

template<class T, class TLock>

class LockedPtr

Pointer wrapper that keeps the object locked for the duration of its existence.

class MainApplication

Main entry point and event loop driver for standard (desktop) applications.

class Material

Contains material data for a drawable node.

class MeshSprite

A scene node representing a mesh with vertices and UVs.

class MouseEvent

Mouse button event.

class MouseState

Current state of the mouse.

class Mutex

Mutex for thread synchronization.

class Object

Base class of all nCine objects.

class Particle

Renders a single particle.

class ParticleAffector

Base class for all particle affectors.

struct ParticleInitializer

Initialization parameters for a batch of emitted particles.

class ParticleSystem

Scene node that emits and simulates a pool of textured particles.

class PositionAffector

Affector that animates the position of a particle.

class RandomGenerator

PCG32 pseudo-random number generator.

class ReadWriteLock

Read/write lock for thread synchronization.

class RectAnimation

Sequence of texture rectangles forming a sprite animation.

class RenderBatcher

Merges compatible render commands into fewer draw calls.

class RenderBuffersManager

Suballocates vertex, index and uniform data from a pool of OpenGL buffer objects.

class RenderCommand

Holds all the state needed to issue a single draw call.

class RenderCommandPool

Pool of reusable render commands.

class RenderDocCapture

In-application integration of the RenderDoc graphics debugger.

class RenderQueue

Sorts and issues the render commands collected during a scene graph visit.

class RenderResources

Creates and holds the OpenGL rendering resources shared by the whole application.

class RenderStatistics

Gathers statistics about the rendering subsystem.

class RenderVaoPool

Pool of reusable Vertex Array Objects.

class RotationAffector

Affector that animates the rotation of a particle.

class SceneNode

Base node of the scene graph transformation hierarchy.

class ScreenViewport

Viewport that renders directly to the screen.

class ScrollEvent

Scroll event (mouse wheel, touchpad gesture, etc.).

class ServiceLocator

Central registry that provides engine services to requesting classes.

class Shader

GPU shader program usable by materials and drawable nodes.

class ShaderState

Binds a custom shader to a drawable node and feeds its uniforms and textures.

class SizeAffector

Affector that animates the scale of a particle.

class Sprite

Scene node that draws a single textured quad.

template<class K, class T, std::uint32_t Capacity, class HashFunc = xxHash32Func<K>>

class StaticHashMap

Statically allocated hashmap with open addressing and leapfrog probing.

template<class K, class T, class HashFunc, std::uint32_t Capacity, bool IsConst>

struct StaticHashMapHelperTraits

Primary template for the StaticHashMapIterator type traits helper.

template<class K, class T, class HashFunc, std::uint32_t Capacity>

struct StaticHashMapHelperTraits<K, T, HashFunc, Capacity, false>

Type traits used by the non-constant StaticHashMapIterator.

template<class K, class T, class HashFunc, std::uint32_t Capacity>

struct StaticHashMapHelperTraits<K, T, HashFunc, Capacity, true>

Type traits used by the constant StaticHashMapIterator.

template<class K, class T, class HashFunc, std::uint32_t Capacity, bool IsConst>

class StaticHashMapIterator

Bidirectional iterator over the elements of a StaticHashMap.

struct StreamDecodeRequest

Request to decode one buffer of audio stream data, usually on the decoding thread.

template<typename T>

struct Task

Awaitable result of an asynchronous coroutine operation.

class TextInputEvent

Text input event.

class Texture

Image data uploaded to the GPU and sampled by shaders.

class TextureFormat

Backend-neutral pixel format descriptor of a texture.

class TextureLoaderDds

Texture loader for the DirectDraw Surface (.dds) format.

class TextureLoaderKtx

Texture loader for the Khronos Texture (.ktx) format.

class TextureLoaderPkm

Texture loader for the ETC1 PKM (.pkm) format.

class TextureLoaderPng

Texture loader for the Portable Network Graphics (.png) format.

class TextureLoaderPvr

Texture loader for the PowerVR (.pvr) format.

class TextureLoaderQoi

Texture loader for the Quite OK Image (.qoi) format.

class TextureLoaderRaw

Texture loader that describes an empty raw-format texture.

class Thread

Operating system thread.

class ThreadAffinityMask

CPU affinity mask for a thread.

class ThreadPool

Thread pool.

class Timer

Stopwatch that accumulates elapsed time across start/stop intervals.

class TimeStamp

Wraps a clock counter value representing a point in time or a duration.

class TouchEvent

Screen touch event.

class UwpApplication

Main entry point and handler for UWP (Universal Windows Platform) applications.

class VelocityAffector

Affector that animates the velocity of a particle.

class Viewport

Render target with its own scene root, camera and render queue.

template<class K>

class xxHash32Func

xxHash3 hash function producing a 32-bit value

template<class K>

class xxHash64Func

xxHash3 hash function producing a 64-bit value

Enums

enum class PrimitiveType : std::uint32_t { Points = 0x0000, Lines = 0x0001, LineLoop = 0x0002, LineStrip = 0x0003, Triangles = 0x0004, TriangleStrip = 0x0005, TriangleFan = 0x0006 }

Primitive topology of a draw call.

enum class BlendingFactor : std::uint32_t { Zero = 0x0000, One = 0x0001, SrcColor = 0x0300, OneMinusSrcColor = 0x0301, SrcAlpha = 0x0302, OneMinusSrcAlpha = 0x0303, DstAlpha = 0x0304, OneMinusDstAlpha = 0x0305, DstColor = 0x0306, OneMinusDstColor = 0x0307, SrcAlphaSaturate = 0x0308, ConstantColor = 0x8001, OneMinusConstantColor = 0x8002, ConstantAlpha = 0x8003, OneMinusConstantAlpha = 0x8004 }

Source or destination factor of the blending equation.

enum class BufferUsage : std::uint32_t { StreamDraw = 0x88E0, StaticDraw = 0x88E4, DynamicDraw = 0x88E8 }

Expected update pattern of a vertex or index buffer.

enum class BufferTarget : std::uint32_t { Vertex = 0x8892, Index = 0x8893, Uniform = 0x8A11 }

Binding target of a buffer object.

enum class MapFlags : std::uint32_t { None = 0, Write = 0x0002, InvalidateRange = 0x0004, InvalidateBuffer = 0x0008, FlushExplicit = 0x0010, Unsynchronized = 0x0020, Persistent = 0x0040, Coherent = 0x0080 }

Buffer mapping and immutable storage flags.

enum class IndexFormat : std::uint32_t { UInt16 = 0x1403, UInt32 = 0x1405 }

Data format of the indices in an index buffer.

enum class CullFaceMode : std::uint32_t { Front = 0x0404, Back = 0x0405, FrontAndBack = 0x0408 }

Face culling mode.

enum class VertexAttribType : std::uint32_t { UnsignedByte = 0x1401, Float = 0x1406 }

Component data type of a vertex attribute.

enum class ShaderStage { Vertex, Fragment }

Programmable pipeline stage a shader source is attached to.

enum class DepthStencilFormat { None, Depth16, Depth24, Depth24_Stencil8 }

Depth and stencil format of a render target.

enum class ClearFlags : std::uint32_t { None = 0, Color = 0x01, Depth = 0x02, Stencil = 0x04 }

Buffers of a render target that can be cleared.

enum class PixelFormat { Unknown, R8, RG8, RGB8, RGBA8, RGB565, RGB5A1, RGBA4, RGB16F, RGBA16F, RGB32F, RGBA32F, Depth16, Depth24, Depth32F, DXT1RGB, DXT1RGBA, DXT3, DXT5, ETC1, ETC2RGB8, ETC2RGB8A1, ETC2RGBA8, EAC_R11, EAC_RG11, ATC_RGB, ATC_RGBA_Explicit, ATC_RGBA_Interpolated, PVRTC_2BPP_RGB, PVRTC_2BPP_RGBA, PVRTC_4BPP_RGB, PVRTC_4BPP_RGBA, ASTC_4x4, ASTC_5x4, ASTC_5x5, ASTC_6x5, ASTC_6x6, ASTC_8x5, ASTC_8x6, ASTC_8x8, ASTC_10x5, ASTC_10x6, ASTC_10x8, ASTC_10x10, ASTC_12x10, ASTC_12x12 }

Pixel format of texture data.

enum class TextureTarget { Texture2D }

Type of texture the backend allocates and binds.

enum class SamplerFilter { Unknown, Nearest, Linear, NearestMipmapNearest, LinearMipmapNearest, NearestMipmapLinear, LinearMipmapLinear }

Texture minification and magnification filtering modes.

enum class SamplerWrapping { Unknown, ClampToEdge, MirroredRepeat, Repeat }

Texture coordinate wrapping modes.

enum class SwizzleChannel { Red, Green, Blue, Alpha, Zero, One }

Source for a sampled texture channel (see Texture::SetSwizzle()).

enum class JoystickGuidType { Unknown, Standard, Default, Hidapi, Xinput }

Well-known joystick GUID layouts.

enum class ButtonName : std::int16_t { Unknown = -1, A = 0, B, X, Y, Back, Guide, Start, LeftStick, RightStick, LeftBumper, RightBumper, Up, Down, Left, Right, Misc1, Paddle1, Paddle2, Paddle3, Paddle4, Touchpad, Count }

Gamepad buttons.

enum class AxisName : std::int16_t { Unknown = -1, LeftX = 0, LeftY, RightX, RightY, LeftTrigger, RightTrigger }

Gamepad axes.

enum class TouchEventType { Down, Up, Move, PointerDown, PointerUp }

Type of a touch event.

enum class MouseButton : short int { Left, Right, Middle, Fourth, Fifth }

Mouse buttons.

enum class Keys { Backspace, Tab, Return, Escape, Space, Quote, Plus, Comma, Minus, Period, Slash, D0, D1, D2, D3, D4, D5, D6, D7, D8, D9, Semicolon, LeftBracket, Backslash, RightBracket, Backquote, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, Delete, NumPad0, NumPad1, NumPad2, NumPad3, NumPad4, NumPad5, NumPad6, NumPad7, NumPad8, NumPad9, NumPadPeriod, NumPadDivide, NumPadMultiply, NumPadMinus, NumPadPlus, NumPadEnter, NumPadEquals, Up, Down, Right, Left, Insert, Home, End, PageUp, PageDown, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, NumLock, CapsLock, ScrollLock, RShift, LShift, RCtrl, LCtrl, RAlt, LAlt, RSuper, LSuper, PrintScreen, Pause, Menu, Clear, Exclaim, QuoteDbl, Hash, Dollar, Ampersand, LeftParen, RightParen, Asterisk, Colon, Less, Equals, Greater, Question, At, Caret, Underscore, Mode, Application, Help, SysReq, Power, Undo, World1, World2, SoftLeft, SoftRight, Back, Call, EndCall, Star, Pound, DpadCenter, VolumeUp, VolumeDown, Camera, Sym, Explorer, Envelope, Num, HeadsetHook, Focus, Notification, Search, MediaPlayPause, MediaStop, MediaNext, MediaPrevious, MediaRewind, MediaFastForward, Mute, PictSymbols, SwitchCharset, ButtonA, ButtonB, ButtonC, ButtonX, ButtonY, ButtonZ, ButtonL1, ButtonR1, ButtonL2, ButtonR2, ButtonThumbLeft, ButtonThumbRight, ButtonStart, ButtonSelect, ButtonMode, FunctionKey, MoveHome, MoveEnd, Forward, MediaPlay, MediaPause, MediaClose, MediaEject, MediaRecord, NumPadComma, NumPadLeftParen, NumPadRightParen, VolumeMute, Info, ChannelUp, ChannelDown, ZoomIn, ZoomOut, TV, Window, Guide, DVR, Bookmark, Captions, Settings, TVPower, TVInput, STBPower, STBInput, AVRPower, AVRInput, ProgRed, ProgGreen, ProgYellow, ProgBlue, AppSwitch, Button1, Button2, Button3, Button4, Button5, Button6, Button7, Button8, Button9, Button10, Button11, Button12, Button13, Button14, Button15, Button16, Count, Unknown = Count }

Keyboard key symbols.

enum KeyMod { None = 0x0000, LShift = 0x0001, RShift = 0x0002, LCtrl = 0x0040, RCtrl = 0x0080, LAlt = 0x0100, RAlt = 0x0200, LSuper = 0x0400, RSuper = 0x0800, NumLock = 0x1000, CapsLock = 0x2000, Mode = 0x4000, Sym = 0x8000, Ctrl = (LCtrl | RCtrl), Shift = (LShift | RShift), Alt = (LAlt | RAlt), Super = (LSuper | RSuper), Mask = (Ctrl | Shift | Alt | Super), Count }

Keyboard modifier flags.

Typedefs

using CreateAppEventHandlerDelegate = std::unique_ptr<IAppEventHandler>(*)()

Delegate that creates an instance of IAppEventHandler.

using hash_t = std::uint32_t

32-bit hash value

using hash64_t = std::uint64_t

64-bit hash value

template<class K, class V, class Hash = xxHash64Func<K>, class Eq = phmap::priv::hash_default_eq<K>>

using HashMap = phmap::flat_hash_map<K, V, Hash, Eq>

Generic hash map.

using FenceHandle = void*

Opaque handle to a GPU fence created by the device.

using NativeArgument = char*

Native argument type, wchar_t* on Windows, otherwise char*.

Functions

auto theApplication() -> Application&

Returns the application instance.

auto lerp(float a, float b, float ratio) -> float

Linearly interpolates between two values by the given ratio.

auto lerp(std::int32_t a, std::int32_t b, float ratio) -> std::int32_t

Linearly interpolates between two integers by the given ratio, rounding the result.

auto lerpByTime(float a, float b, float ratio, float timeMult) -> float

Frame-rate independent interpolation between two values.

auto copyStringFirst(char* dest, std::int32_t destSize, const char* source, std::int32_t count = -1) -> std::int32_t

Copies the beginning of a string into a fixed-size buffer, always null-terminating it.

template<std::size_t size>

auto copyStringFirst(char(&dest)[size], const char* source, std::int32_t count = -1) -> std::int32_t

Copies the beginning of a string into a fixed-size array, deducing its size.

template<std::size_t size>

auto copyStringFirst(char(&dest)[size], Containers::StringView source) -> std::int32_t

Copies the beginning of a string view into a fixed-size array, deducing its size.

auto formatString(char* buffer, std::size_t maxLen, const char* format, ...) -> std::int32_t

Writes a printf-style formatted string into a buffer.

template<std::size_t size, class ... TArg>

auto formatString(char(&dest)[size], const char* format, const TArg&... args) -> std::int32_t

Writes a printf-style formatted string into a fixed-size array, deducing its size.

void u32tos(std::uint32_t value, char* buffer)

Writes an unsigned 32-bit integer to a buffer as a decimal string.

void i32tos(std::int32_t value, char* buffer)

Writes a signed 32-bit integer to a buffer as a decimal string.

void u64tos(std::uint64_t value, char* buffer)

Writes an unsigned 64-bit integer to a buffer as a decimal string.

void i64tos(std::int64_t value, char* buffer)

Writes a signed 64-bit integer to a buffer as a decimal string.

void ftos(double value, char* buffer, std::int32_t bufferSize)

Writes a floating-point value to a buffer as a decimal string.

auto isDigit(char c) -> bool constexpr

Returns true if the character is a decimal digit.

auto stou32(const char* str, std::size_t length) -> std::uint32_t constexpr

Parses up to length leading decimal digits into an unsigned 32-bit integer.

auto stou64(const char* str, std::size_t length) -> std::uint64_t constexpr

Parses up to length leading decimal digits into an unsigned 64-bit integer.

template<class Iter, class Compare>

void sort(Iter begin, Iter end, Compare comp)

Sorts the range in place using the given comparator.

template<class Iter>

void sort(Iter begin, Iter end)

Sorts the range in place into ascending order.

auto halfToFloat(std::uint16_t value) -> float

Converts a 16-bit half-precision value to a single-precision float.

auto floatToHalf(float value) -> std::uint16_t

Converts a single-precision float to a 16-bit half-precision value.

auto parseVersion(Containers::StringView version) -> std::uint64_t constexpr

Packs a dotted version string into a single 64-bit number.

template<class Iterator>

static auto toBase64Url(const Iterator begin, const Iterator end) -> std::string

Encodes the byte range into a URL-safe Base64 string (without padding).

auto crc32(Containers::ArrayView<std::uint8_t> data) -> std::uint32_t

Returns the CRC-32 checksum of the given byte buffer.

auto crc32(IO::Stream& stream) -> std::uint32_t

Returns the CRC-32 checksum of the remaining contents of the given stream.

auto clock() -> Clock&

Returns the shared system clock instance.

auto Random() -> RandomGenerator& noexcept

Returns the shared random number generator instance.

auto operator|(MapFlags a, MapFlags b) -> MapFlags constexpr

auto operator&(MapFlags a, MapFlags b) -> MapFlags constexpr

auto operator|(ClearFlags a, ClearFlags b) -> ClearFlags constexpr

auto operator&(ClearFlags a, ClearFlags b) -> ClearFlags constexpr

auto theServiceLocator() -> ServiceLocator&

Returns the singleton service locator instance.

auto _(const char* text) -> StringView

Translates text in singular form using the primary translation catalog.

auto _x(StringView context, const char* text) -> StringView

Translates text in singular form using the primary translation catalog and the specified context.

auto _n(const char* singular, const char* plural, std::int32_t n) -> StringView

Translates text in singular or plural form (selected by count n) using the primary translation catalog.

auto _nx(StringView context, const char* singular, const char* plural, std::int32_t n) -> StringView

Translates text in singular or plural form (selected by count n) using the primary translation catalog and the specified context.

template<class ... Args>

auto _f(const char* text, const Args&... args) -> String

Translates and formats text in singular form using the primary translation catalog.

template<class ... Args>

auto _fn(const char* textSingular, const char* textPlural, std::int32_t n, const Args&... args) -> String

Translates and formats text in singular or plural form (selected by count n) using the primary translation catalog.

Variables

const hash_t NullHash

Reserved hash value marking an empty or invalid entry.

const unsigned int StepsInitialSize

Initial capacity reserved for the step array of each affector.

Constants

double Pi constexpr

3.1415... (double)

float fPi constexpr

3.1415...

float fPiOver2 constexpr

3.1415... / 2

float fPiOver3 constexpr

3.1415... / 3

float fPiOver4 constexpr

3.1415... / 4

float fPiOver6 constexpr

3.1415... / 6

float fTwoPi constexpr

3.1415... * 2

double DegToRad constexpr

Multiply to convert degrees to radians (double).

float fDegToRad constexpr

Multiply to convert degrees to radians.

double RadToDeg constexpr

Multiply to convert radians to degrees (double).

float fRadToDeg constexpr

Multiply to convert radians to degrees.

float fRadAngle1 constexpr

1 degree as radians

float fRadAngle30 constexpr

30 degrees as radians

float fRadAngle45 constexpr

45 degrees as radians

float fRadAngle90 constexpr

90 degrees as radians

float fRadAngle180 constexpr

180 degrees as radians

float fRadAngle270 constexpr

270 degrees as radians

float fRadAngle360 constexpr

360 degrees as radians

Enum documentation

Typedef documentation

Function documentation

Variable documentation