Classes
-
namespace Death Shared root namespace.
-
namespace Backward Exception handling implementation.
- class ExceptionHandling Unhandled exception handling.
- class Printer Exception and stack trace printer.
-
struct ResolvedTrace Resolved trace item.
- struct SourceLoc Source location description.
- class SnippetFactory Helps to create snippets from source code.
- class SourceFile Represents a file with source code.
- class StackTraceBase Base class of stack trace.
- struct Trace Raw trace item.
- class TraceResolverBase Base class for trace resolving.
-
namespace Containers Container implementations.
- namespace Literals Container literals.
- namespace StringUtils String utilities.
- struct AllocatedInitT Allocated initialization tag type.
- class Array Array.
- struct ArrayAllocator Allocator for growable arrays.
- struct ArrayMallocAllocator Malloc-based allocator for growable arrays.
- struct ArrayNewAllocator New-based allocator for growable arrays.
- class ArrayView Array view.
- class ArrayView<const void> Constant void array view.
- class ArrayView<void> Void array view.
- class BasicStringView Base for string views.
- class ComPtr Wraps the interface pointer of the specified type and maintains a reference count.
- class DateTime Instant in time, typically expressed as a date and time of day.
- struct DefaultInitT Default initialization tag type.
- struct DirectInitT Direct initialization tag type.
- class Function Function wrapper.
- class Function<R(Args...)> Function wrapper.
- class FunctionData Function data storage
- struct InPlaceInitT In-place initialization tag type.
- struct NoAllocateInitT No-allocate initialization tag type.
- struct NoCreateT No creation tag type.
- struct NoInitT No initialization tag type.
- class Pair Pair of values.
- class Reference Lightweight non-owning reference wrapper.
- class SmallVector Memory-optimized vector.
- class SmallVectorBase Base class of SmallVector.
- class SmallVectorImpl Common method implementations of SmallVector class to reduce code duplication based on
Ntemplate parameter. - struct SmallVectorStorage Storage for SmallVector in-place elements.
- class SmallVectorTemplate Template method specializations of SmallVector depending on whether type is trivial or not.
- class SmallVectorTemplateCommon Common template of SmallVector which does not depend on whether the type is trivial or not.
- class StaticArray Compile-time-sized array.
- class StaticArrayView Compile-time-sized array view.
- class String String.
- class StringBuilder Resulting template class of a deferred string concatenation.
- struct StringBuilderBase Resulting base class of a deferred string concatenation.
- class TimeSpan Time interval.
- struct ValueInitT Value initialization tag type.
-
namespace Cpu Compile-time and runtime CPU instruction set detection and dispatch.
- struct Avx2T AVX2 tag type.
- struct Avx512fT AVX-512 Foundation tag type.
- struct AvxF16cT AVX F16C tag type.
- struct AvxFmaT AVX FMA tag type.
- struct AvxT AVX tag type.
- struct Bmi1T BMI1 tag type.
- struct Bmi2T BMI2 tag type.
- class Features Feature set.
- struct LzcntT LZCNT tag type.
- struct NeonFmaT NEON FMA tag type.
- struct NeonFp16T NEON FP16 tag type.
- struct NeonT NEON tag type.
- struct PopcntT POPCNT tag type.
- struct ScalarT Scalar tag type.
- struct Simd128T SIMD128 tag type.
- struct Sse3T SSE2 tag type.
- struct Sse41T SSE4.1 tag type.
- struct Sse42T SSE4.2 tag type.
- struct Ssse3T SSSE3 tag type.
- struct TypeTraits Traits class for CPU detection tag types.
- namespace Cryptography Cryptographic and hashing utilities.
- namespace Environment Platform-specific environment helper functions.
-
namespace IO File system, streaming and IO-related classes.
-
namespace Compression Data compression streaming interfaces.
- class DeflateStream Provides read-only streaming of compressed data using the Deflate algorithm.
- class DeflateWriter Provides write-only streaming to compress written data by using the Deflate algorithm.
- class Lz4Stream Provides read-only streaming of compressed data using the LZ4 compression algorithm.
- class Lz4Writer Provides write-only streaming to compress written data by using the LZ4 compression algorithm.
- class Lzma2Stream Provides read-only streaming of compressed data using the LZMA2 compression algorithm.
- class Lzma2Writer Provides write-only streaming to compress written data by using the LZMA2 compression algorithm.
- class ZstdStream Provides read-only streaming of compressed data using the Zstandard compression algorithm.
- class ZstdWriter Provides write-only streaming to compress written data by using the Zstandard compression algorithm.
- class AndroidAssetStream Read-only streaming directly from Android asset files.
- class BoundedFileStream Provides only specified portion of the specified seekable input stream.
- class EmscriptenFilePicker Allows a user to pick files in the browser.
- class EmscriptenFileStream Provides access to a file selected by the user in the browser.
- class FileStream Allows streaming from/to a file on a local filesystem.
-
class FileSystem File system related methods.
- class Directory Handles directory traversal, should be used as iterator.
- class MapDeleter Memory-mapped file deleter.
- class MemoryStream Provides stream interface for a region of memory.
-
class PakFile Provides read-only access to contents of
.pakfile.- class Directory Handles directory traversal, should be used as iterator.
- class PakWriter Allows to create a
.pakfile. - class Stream Provides a generic view of a sequence of bytes.
- class WebAuthChallenge Contains the authentication challenge information.
- class WebCredentials Contains the username and password to use for authenticating.
- class WebProxy Describes the proxy settings to be used by the session.
- class WebRequest Represents web request.
- class WebRequestAsync Represents asynchronous web request.
-
class WebRequestBase Base class of web requests.
- struct Result Result of synchronous operation.
- class WebRequestEvent Result of the asynchronous web request.
- class WebResponse Describes the server response of the web request.
- class WebSession Represents web session that allows WebRequest to be created.
- class WebSessionAsync Represents web session that allows WebRequestAsync to be created.
- class WebSessionBase Base class of web sessions.
-
namespace Compression Data compression streaming interfaces.
- namespace Memory Memory-related utilities.
- namespace Threading Multithreading-related classes.
-
namespace Trace Runtime event tracing implementation, should be used along with Asserts.h.
- class BacktraceStorage Storage for deferred transit events.
- class Logger Logger enqueues trace items for processing.
- class LoggerBackend Logger backend processes trace items in the background.
- class ScopedThreadContext Handles lifetime of the thread context.
- class ThreadContext Stores information about the current thread and allows to receive logged entries.
- class ThreadContextManager Manages thread contexts for LoggerBackend.
- struct TransitEvent Stores required information about a logged entry to be dispatched to sinks.
- class TransitEventBuffer Circular buffer for transit events.
- namespace Utf8 Unicode (UTF-8. UTF-16 and UTF-32) utilities.
- class IDisposable Base interface for releasing resources on object destruction.
- class ITraceSink Interface for sink to be used by logger writing to it.
-
namespace Backward Exception handling implementation.
-
namespace Jazz2 Root namespace of Jazz² Resurrection.
-
namespace Actors Implementation of all objects.
-
namespace Bosses Enemy bosses.
- class Bilsy Bilsy (boss).
- class Bolly Bolly (boss).
- class BossBase Base class of an enemy boss.
- class Bubba Bubba (boss).
- class Devan Devan (boss).
- class DevanRemote Devan with remote control (boss).
- class Queen Queen (boss).
- class Robot Robot (boss).
- class TurtleBoss Turtle (boss).
- class Uterus Uterus (boss).
-
namespace Collectibles Collectibles.
- class AmmoCollectible Ammo (collectible).
- class CarrotCollectible Carrot (collectible).
- class CarrotFlyCollectible Fly carrot (collectible).
- class CarrotInvincibleCollectible Invincible carrot (collectible).
- class CoinCollectible Coin (collectible).
- class CollectibleBase Base class of a collectible object.
- class FastFireCollectible Fast fire (collectible).
- class FoodCollectible Food (collectible).
- class GemCollectible Gem (collectible).
- class GemGiant Giant gem.
- class GemRing Gem ring.
- class OneUpCollectible 1up (collectible)
- class Stopwatch Stopwatch.
-
namespace Enemies Enemies.
- class Bat Bat.
- class Bee Bee.
- class Caterpillar Caterpillar.
- class Crab Crab.
- class Demon Demon.
- class Doggy Doggy.
- class Dragon Dragon.
- class Dragonfly Dragonfly.
- class EnemyBase Base class of an enemy.
- class FatChick Fat chick.
- class Fencer Fencer.
- class Fish Fish.
- class Helmut Helmut.
- class LabRat Lab rat.
- class Lizard Lizard.
- class LizardFloat Floating lizard.
- class MadderHatter Madder hatter.
- class Monkey Monkey.
- class Rapier Rapier.
- class Raven Raven.
- class Skeleton Skeleton.
- class Sparks Sparks.
- class Sucker Sucker.
- class SuckerFloat Floating sucker.
- class Turtle Turtle.
- class TurtleShell Turtle shell.
- class TurtleTough Tough turtle.
- class TurtleTube Tube turtle.
- class Witch Witch.
-
namespace Environment Environmental objects.
- class AirboardGenerator Airboard generator.
- class AmbientBubbles Ambient bubbles.
- class AmbientSound Ambient sound.
- class Bird Bird.
- class BirdCage Bird cage.
- class Bomb Bomb.
- class BonusWarp Bonus warp.
- class Checkpoint Checkpoint.
- class Copter Copter.
- class EndOfLevel End of level sign.
- class Eva Eva.
- class IceBlock Ice block.
- class Moth Moth.
- class RollingRock Rolling rock.
- class Spring Spring.
- class SteamNote Steam note.
- class SwingingVine Swinging vine.
-
namespace Lighting Lighting effects.
- class FlickerLight Flickering light.
- class PulsatingRadialLight Pulsating radial light.
- class StaticRadialLight Static radial light.
-
namespace Multiplayer Multiplayer-related objects, compiled only if
WITH_MULTIPLAYER.- class LocalPlayerOnServer Local player in online session.
- class MpPlayer Player in online session.
- class PlayerOnServer Player on the server in online session.
- class RemotablePlayer Remotable player in online session.
- class RemoteActor Remote object in online session.
- class RemotePlayerOnServer Remote player in online session.
-
namespace Solid Solid objects.
- class AmmoBarrel Ammo barrel.
- class AmmoCrate Ammo crate.
- class BarrelContainer Barrel container.
- class Bridge Bridge.
- class CrateContainer Crate container.
- class GemBarrel Gem barrel.
- class GemCrate Gem crate.
-
class GenericContainer Base class of an item container.
- struct ContainerContent Container content item.
- class MovingPlatform Moving platform.
- class PinballBumper Pinball bumper.
- class PinballPaddle Pinball paddle.
- class Pole Pole.
- class PowerUpMorphMonitor Power-up morph monitor.
- class PowerUpShieldMonitor Power-up shield monitor.
- class PowerUpWeaponMonitor Power-up weapon monitor.
- class PushableBox Pushable box.
- class SpikeBall Spike ball.
- class TriggerCrate Trigger crate.
-
namespace Weapons Weapons.
- class BlasterShot Blaster (shot).
- class BouncerShot Bouncer (shot).
- class ElectroShot Electro (shot).
- class FreezerShot Freezer (shot).
- class PepperShot Pepper (shot).
- class RFShot RF (shot).
- class SeekerShot Seeker (shot).
- class ShieldFireShot Fire shield (shot).
- class ShieldLightningShot Lightning shield (shot).
- class ShieldWaterShot Water shield (shot).
- class ShotBase Base class of a shot from a player's weapon.
- class Thunderbolt Thunderbolt (shot).
- class TNT TNT.
- class ToasterShot Toaster (shot).
- struct ActorActivationDetails Description how to initialize an actor.
-
class ActorBase Base class of an object.
- class ActorRenderer Actor renderer.
- class Explosion Explosion effects.
- class Player Represents a controllable player.
- class PlayerCorpse Represents a dead corpse of a player.
- class SolidObjectBase Base class of a (pushable) solid object.
-
namespace Bosses Enemy bosses.
-
namespace Collisions Collision checking.
- struct CollisionPair Collided pair of objects found by collision detection.
- class DynamicTree Dynamic AABB tree broad-phase.
- class DynamicTreeBroadPhase Broad-phase for collision detection.
- struct TreeNode Node in the dynamic tree.
-
namespace Compatibility Translation layer for original data files.
-
class AnimSetMapping Maps indices from original data file to organized entries.
- struct Entry Mapped entry.
- struct ConversionResult Converted extended event description.
- class EventConverter Maps original events to extended event descriptions.
- class JJ2Anims Parses original
.j2aanimation files. - class JJ2Block Processes compressed or uncompressed blocks from original files (in little endian).
-
class JJ2Data Parses original
.j2ddata files.- struct Item Item from a
.j2ddata file.
- struct Item Item from a
- class JJ2Episode Parses original
.j2e/.j2peepisode files. -
class JJ2Level Parses original
.j2llevel files.- struct AlternatePalette Alternate palette.
- struct ExtraTilesetEntry Extra tileset used in the level.
- struct LevelToken Episode name and level name.
-
class JJ2Strings Parses original
.j2slocalization files.- struct LevelEntry Texts for specific level.
- class JJ2Tileset Parses original
.j2ttile set files.
-
class AnimSetMapping Maps indices from original data file to organized entries.
-
namespace Events Events and object spawning.
-
class EventMap Represents event map, spawns triggered objects.
- struct EventTile Represents an event tile.
- class EventSpawner Spawns objects in a level.
-
class EventMap Represents event map, spawns triggered objects.
-
namespace Input Input handling.
- class ControlScheme Provides access to a user configured control scheme.
- struct ControlSchemeMapping Control mapping for a particular action.
- struct MappingTarget Control mapping target.
- struct ProcessedInput Result returned by ControlScheme::
FetchProcessedInput(). - class RgbLights Provides access to RGB lights from various peripherals.
- class RumbleDescription Describes a gamepad rumble effect.
- class RumbleProcessor Gamepad rumble processor.
-
namespace Multiplayer Multiplayer-related classes, compiled only if
WITH_MULTIPLAYER.- struct AllPeersT All connected peers tag type.
- struct ConnectionResult Describes a connection result of INetworkHandler::
OnPeerConnected(). - class INetworkHandler Interface to handle incomming network requests.
- class IServerObserver Interface to observe publicly-listed running servers.
- class IServerStatusProvider Interface to provide current status of the server.
- struct LocalPeerT Local peer tag type.
-
class MpLevelHandler Level handler of an online multiplayer game session.
- struct MultiplayerSpawnPoint
- struct PendingSfx
- struct PlayerName
- struct PlayerPositionInRound
- struct RemotingActorInfo
- struct RequiredAsset
- class NetworkManager Manages game-specific network connections.
- class NetworkManagerBase Allows to create generic network clients and servers.
- struct Peer Remote peer as opaque handle.
- struct PeerDescriptor Peer descriptor.
- struct PlaylistEntry Playlist entry in ServerConfiguration.
- struct ServerConfiguration Server configuration.
- struct ServerDescription Server description.
- class ServerDiscovery Allows to monitor publicly-listed running servers for server listing.
- struct ServerInitialization Server initialization parameters.
-
namespace Rendering Scene rendering and viewport management.
- class BlurRenderPass Applies blur to a scene.
- class CombineRenderer Combines all previous passes of a scene into a resulting image.
- class LightingRenderer Processes all lights in a scene into an intermediate target.
- class PlayerViewport Player viewport.
-
class UpscaleRenderPass Upscales input image usually to a native resolution.
- class AntialiasingSubpass Optional antialiasing subpass.
- class UpscaleRenderPassWithClipping Upscales input image usually to a native resolution, additionaly supports 3 independent layers (background layer, clipped main layer, overlay layer).
-
namespace Resources Structures for game resources.
- struct Episode Describes an episode.
- struct GenericGraphicResource Shared graphic resource.
- struct GenericSoundResource Shared sound resource.
- struct GraphicResource Specific graphic resource (from metadata).
- struct Metadata Contains assets for specific object type.
- struct SoundResource Specific sound resource (from metadata).
-
namespace Scripting Scripting-related classes, compiled only if
WITH_ANGELSCRIPT.-
namespace Legacy Legacy JJ2+ definitions.
- class jjANIMATION A sprite animation consisting of a sequence of frames.
- class jjANIMFRAME A single frame of a sprite animation.
- class jjANIMSET A set of related sprite animations.
- struct jjBEHAVIOR Holds the behavior assigned to an object: a built-in id, a script function, or a script object.
- struct jjCANVAS Drawing surface used by scripts to render onto the HUD.
- class jjCHARACTER Movement and ability settings for a playable character.
- class jjLAYER A tilemap layer of the level.
- class jjMASKMAP A rectangular collision mask of solid/empty pixels.
- class jjOBJ A level object (actor) controllable from scripts.
- class jjPAL A 256-color palette.
- struct jjPALCOLOR A single RGB palette color.
- class jjPARTICLE A visual particle in the level.
- struct jjPARTICLEFIRE Per-particle data for a fire particle.
- struct jjPARTICLEFLOWER Per-particle data for a flower particle.
- struct jjPARTICLEICETRAIL Per-particle data for an ice trail particle.
- struct jjPARTICLELEAF Per-particle data for a leaf particle.
- struct jjPARTICLEPIXEL Per-particle data for a pixel particle.
- struct jjPARTICLERAIN Per-particle data for a rain particle.
- struct jjPARTICLESMOKE Per-particle data for a smoke particle.
- struct jjPARTICLESNOW Per-particle data for a snow particle.
- struct jjPARTICLESPARK Per-particle data for a spark particle.
- struct jjPARTICLESTAR Per-particle data for a star particle.
- struct jjPARTICLESTRING Per-particle data for a text (score) particle.
- class jjPIXELMAP A rectangular buffer of palette-indexed pixels.
- class jjPLAYER A player in the level.
- struct jjPLAYERDRAW Controls which parts of a player are drawn and how.
- class jjRNG A seedable pseudo-random number generator.
- class jjSTREAM A binary data stream for serialization and file I/O.
- struct jjTEXTAPPEARANCE Describes how text is rendered (spacing, animation and special-character handling).
- class jjWEAPON Settings for a weapon type.
- class CScriptArray AngelScript array
-
class CScriptDictionary AngelScript dictionary
- class CIterator AngelScript dictionary iterator
- class CScriptDictValue AngelScript dictionary value
- class CScriptHandle AngelScript reference handle
- class LevelScriptLoader Binds an AngelScript script file to LevelHandler and executes the script.
- class ScriptActorWrapper Wraps a scripted actor, forwarding engine callbacks to the AngelScript object.
- class ScriptCollectibleWrapper Wraps a scripted collectible actor, forwarding engine callbacks to the AngelScript object.
- class ScriptLoader Generic AngelScript script loader with
#includeand#pragmadirective support. - class ScriptPlayerWrapper Wraps a player actor for access from AngelScript.
-
namespace Legacy Legacy JJ2+ definitions.
-
namespace Tiles Tile sets and maps.
- struct AnimatedTile Represents an animated tile.
- struct AnimatedTileFrame Represents a single frame of an animated tile.
- class ITileMapOwner Interface used to notify tile map owner of various events.
- struct LayerDescription Description of a tile map layer.
- struct LayerTile Represents a single tile in a tile map layer.
- struct TileCollisionParams Describes how the object interacts and collides with the environment.
-
class TileMap Represents a renderable tile map, consists of multiple layers.
- struct DestructibleDebris Describes a visual debris (particle effect).
- struct TileMapLayer Represents a single tile map layer.
- class TileSet Represents tile set used by tile map, consists of texture and collision mask.
-
namespace UI User interface and menus.
-
namespace Menu Menu implementation.
- namespace Resources Common menu resources defined in
Metadata/UI/MainMenu.res. - class AboutSection About menu section.
- class BeginSection Main menu root section.
- class ControlsOptionsSection Controls options menu section.
- class CreateServerOptionsSection Create server options menu section.
- class CustomLevelSelectSection Custom level selection menu section.
- class EpisodeSelectSection Episode selection menu section.
- class FirstRunSection First run menu section.
- class GameplayEnhancementsSection Gameplay enhancements menu section.
- class GameplayOptionsSection Gameplay options menu section.
- class GraphicsOptionsSection Graphics options menu section.
- class HighscoresSection Highscores menu section.
- class IMenuContainer Base interface of a menu container.
- class ImportSection Import Episodes menu section (Emscripten only).
- class InGameMenu In-game menu.
- class InputDiagnosticsSection Input diagnostics menu section.
- class LanguageSelectSection Language selection menu section.
- class MainMenu Main menu.
- class MenuSection Base class of a menu section.
- class MultiplayerGameModeSelectSection Multiplayer game mode selection menu section.
- class OptionsSection Options menu section.
- class PauseSection In-game menu root section.
- class PlayMultiplayerSection Play multiplayer menu section.
- class RefreshCacheSection Refresh cache menu section.
- class RemapControlsSection Remap controls menu section.
- class RescaleModeSection Rescale mode selection menu section.
-
class ScrollableMenuSection Simplifies creation of unified scrollable menu sections.
- struct ListViewItem Generic item in ScrollableMenuSection.
- class ServerSelectSection Server selection menu section.
- class SimpleMessageSection Section showing a simple message.
- class SoundsOptionsSection Sounds options menu section.
- class StartGameOptionsSection Start game options menu section.
- class TextInputBuffer Helper class that manages text editing state for text input fields.
-
class TouchControlsOptionsSection Touch controls options menu section.
- struct ButtonRect Axis-aligned box for a button preview.
- class UserProfileOptionsSection User profile options menu section.
- namespace Resources Common menu resources defined in
-
namespace Multiplayer Multiplayer-related user interface, compiled only if
WITH_MULTIPLAYER.- class MpHUD Player HUD for multiplayer.
- class MpInGameCanvasLayer In-game canvas on sprite layer for multiplayer.
- class MpInGameLobby In-game lobby screen for multiplayer.
- class Canvas Canvas.
- class Cinematics Handler that plays a cinematic video.
-
class DiscordRpcClient Allows interactions with running Discord client.
- struct RichPresence Rich presence description.
- class Font Bitmap font renderer.
- class FormattedTextBlock Formatted text block.
- struct FormattedTextBlockParams Initialization parameters for formatted text block.
- class HUD Player HUD.
- class InGameConsole In-game console.
- class LoadingHandler Handler that only shows the loading indicator.
-
namespace Menu Menu implementation.
-
class ContentResolver Manages loading of assets.
- struct StringRefEqualTo
- struct EpisodeContinuationState Continuation state between two episodes.
- struct EpisodeContinuationStateWithLevel Continuation state between two levels in episode.
- class ILevelHandler Base interface of a level handler.
- class IResumable Base interface of a resumable object.
- class IRootController Base interface of a root controller.
- class IStateHandler Base interface of a state handler, only one handler runs at a time.
- struct LevelDescriptor Contains all components to fully initialize a level instance.
-
class LevelHandler Level handler of a local game session.
- struct PlayerInput Describes current input state of a player.
- struct LevelInitialization Level initialization parameters.
- struct LightEmitter Allows objects to emit light.
- struct PlayerCarryOver Player carry over between levels.
- class PreferencesCache Provides access to a user preferences.
- struct TouchButtonLayout Per-button layout stored in user preferences.
-
namespace Actors Implementation of all objects.
-
namespace nCine Root namespace of nCine game engine.
-
namespace Backends Platform-specific backends.
- class AndroidInputManager Parses and dispatches Android input events.
- class AndroidJniClass Base class for the JNI wrappers that hold a reference to a Java object.
- class AndroidJniClass_Display Wraps JNI access to
android.view.Display. - class AndroidJniClass_DisplayMode Wraps JNI access to
android.view.Display.Mode. - class AndroidJniClass_InputDevice Wraps JNI access to
android.view.InputDevice. - class AndroidJniClass_KeyCharacterMap Wraps JNI access to
android.view.KeyCharacterMap. - class AndroidJniClass_KeyEvent Wraps JNI access to
android.view.KeyEvent. - class AndroidJniClass_MotionRange Wraps JNI access to
android.view.InputDevice.MotionRange. - class AndroidJniClass_Version Wraps JNI access to
android.os.Build.VERSION. - class AndroidJniClass_VibrationEffect Wraps JNI access to
android.os.VibrationEffect. - class AndroidJniClass_Vibrator Wraps JNI access to
android.os.Vibrator. - class AndroidJniClass_VibratorManager Wraps JNI access to
android.os.VibratorManager. - class AndroidJniHelper Sets up the JNI environment and initializes the wrapper classes.
- class AndroidJniWrap_Activity Wraps JNI access to
android.app.Activity. - class AndroidJniWrap_DisplayManager Wraps JNI access to
android.hardware.display.DisplayManager. - class AndroidJniWrap_InputMethodManager Wraps JNI access to
android.view.inputmethod.InputMethodManager. - class AndroidJniWrap_Secure Wraps JNI access to
android.provider.Settings.Secure. - class AndroidJoystickState Information about Android joystick state.
- class AndroidKeyboardState Simulated information about Android keyboard state.
- class AndroidKeys Utility functions to convert between engine key enumerations and Android ones.
- class AndroidMouseState Information about Android mouse state.
- class EglGfxDevice The EGL-based graphics device.
- class GlfwGfxDevice GLFW-based graphics device.
- class GlfwInputManager GLFW-based input manager.
- class GlfwJoystickState Information about GLFW joystick state.
- class GlfwKeyboardState Information about GLFW keyboard state.
- class GlfwKeys Utility functions to convert between engine key enumerations and GLFW ones.
- class GlfwMouseState Information about GLFW mouse state.
- class GlfwScrollEvent Information about a GLFW scroll event.
- class Qt5GfxDevice Graphics device that wraps a Qt5 Qt5Widget.
- class Qt5InputManager Parses and dispatches Qt5 input events.
- class Qt5JoystickState Information about Qt5 joystick state.
- class Qt5KeyboardState Simulated information about Qt5 keyboard state.
- class Qt5Keys Utility functions to convert between engine key enumerations and Qt5 ones.
- class Qt5MouseEvent Information about a Qt5 mouse event.
- class Qt5MouseState Information about Qt5 mouse state.
- class Qt5ScrollEvent Information about a Qt5 scroll event.
- class SdlGfxDevice SDL2-based graphics device.
- class SdlInputManager SDL2-based input manager.
- class SdlJoystickState Information about SDL2 joystick state.
- class SdlKeyboardState Information about SDL2 keyboard state.
- class SdlKeys Utility functions to convert between engine key enumerations and SDL2 ones.
- class SdlMouseState Information about SDL2 mouse state.
- class SdlScrollEvent Information about an SDL2 scroll event.
- class UwpGfxDevice The UWP graphics device.
- class UwpInputManager Class for dispatching UWP input events.
- class UwpJoystickState Information about UWP joystick state.
- class UwpKeyboardState Information about UWP keyboard state.
- class UwpMouseState Information about UWP mouse state.
-
namespace Primitives Primitives.
- namespace Literals Literals for primitives.
- class AABB Axis-aligned bounding box in a two-dimensional space.
- class Color Four-channel color with 8-bit integers per component.
- class Colorf Four-channel normalized color with 32-bit floats per component.
- class Half Half-precision float literal.
- class Matrix4x4 Four-by-four matrix.
- struct NoInitT No initialization tag type.
- class Quaternion Quaternion.
- class Rect Rectangle in a two-dimensional space.
- class Vector2 Two-component vector.
- class Vector3 Three-component vector.
- class Vector4 Four-component vector.
- 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.
- struct GuiSettings GUI settings (for ImGui) that can be changed at run-time.
- struct RenderingSettings Rendering settings that can be changed at run-time.
- 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.
- class BitSet Fixed-size sequence of bits backed by an unsigned integer.
-
class Camera Provides the projection and view matrices used by shaders.
- struct ProjectionValues Values describing the orthographic projection matrix.
- struct ViewValues Values describing the 2D view matrix.
- class Clock High-resolution monotonic system clock.
-
class ColorAffector Affector that animates the color of a particle.
- struct ColorStep A color keyed to a normalized particle age.
- 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.
- 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.
- class GLAttribute Stores information about an active vertex shader attribute.
-
class GLBlending Manages the OpenGL blending state.
- struct State Holds the cached blending state.
- class GLBufferObject Wraps an OpenGL buffer object.
- class GLBufferObjectMappingFunc Maps OpenGL buffer object targets to bucket indices.
-
class GLClearColor Manages the OpenGL clear color.
- struct State Holds the cached clear color state.
-
class GLCullFace Manages the OpenGL face culling state.
- struct State Holds the cached face culling state.
-
class GLDebug Wrapper around OpenGL debug output and object labelling.
- class ScopedGroup RAII scope for an OpenGL debug message group.
-
class GLDepthTest Manages the OpenGL depth test state.
- struct State Holds the cached depth test state.
- class GLFramebuffer Wraps an OpenGL framebuffer object.
- class GLHashMap Naive fixed-size hashmap of OpenGL targets to object ids.
- class GLRenderbuffer Wraps an OpenGL renderbuffer object.
-
class GLScissorTest Manages the OpenGL scissor test state.
- struct State Holds the cached scissor test state.
- class GLShader Wraps an OpenGL shader object.
- class GLShaderProgram Wraps an OpenGL shader program object.
- class GLShaderUniformBlocks Manages the uniform block caches of a shader program.
- class GLShaderUniforms Manages the uniform caches of a shader program.
- class GLTexture Wraps an OpenGL texture object.
- class GLTextureMappingFunc Maps OpenGL texture targets to bucket indices.
- class GLUniform Stores information about an active shader uniform.
- class GLUniformBlock Stores information about an active uniform block.
- class GLUniformBlockCache Caches the contents of a uniform block and uploads it through a buffer object.
- class GLUniformCache Caches the value of a single uniform and uploads it to the shader.
- class GLVertexArrayObject Wraps an OpenGL vertex array object.
-
class GLVertexFormat Describes the format of a vertex.
- class Attribute A single vertex attribute within a vertex format.
-
class GLViewport Manages the OpenGL viewport rectangle.
- struct State Holds the cached viewport state.
- 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.
- struct DisplaySettings Settings controlling which parts of the debug overlay are shown.
-
class IGfxCapabilities Interface to query runtime OpenGL device capabilities.
- struct GLInfoStrings OpenGL information strings.
-
class IGfxDevice Represents the interface to the graphics device where everything is rendered.
- struct GLContextInfo Attributes used to create an OpenGL context.
- struct Monitor Connected monitor.
- struct VideoMode Video mode supported by a monitor.
- struct WindowMode Initial properties of the application window.
- 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.
- 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.
- struct Vertex Vertex data for the mesh.
- struct VertexNoTexture Vertex data for the mesh when no texture is specified.
- 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.
- struct PositionStep A position offset keyed to a normalized particle age.
- 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.
- struct BufferSpecifications Configuration of a buffer object for a given type.
- struct Parameters Result of a memory request, locating a sub-range within a buffer object.
- 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.
- struct CameraUniformData Per-shader camera uniform data and the frames its matrices were last updated.
- struct VertexFormatPos2 Vertex format for vertices with positions only.
- struct VertexFormatPos2Index Vertex format for vertices with positions and draw indices.
- struct VertexFormatPos2Tex2 Vertex format for vertices with positions and texture coordinates.
- struct VertexFormatPos2Tex2Index Vertex format for vertices with positions, texture coordinates and draw indices.
-
class RenderStatistics Gathers statistics about the rendering subsystem.
- class Buffers Counters for the managed buffers of a single type.
- class CommandPool Counters for the render command pool used/free sizes and retrievals.
- class Commands Counters for render commands of a single type or aggregated across all types.
- class CustomBuffers Counters for custom VBOs or IBOs and their total memory usage.
- class Textures Counters for textures and their total video memory usage.
- class VaoPool Counters for the VAO pool size, capacity, reuses and bindings.
- class RenderVaoPool Pool of reusable Vertex Array Objects.
-
class RotationAffector Affector that animates the rotation of a particle.
- struct RotationStep An angle offset keyed to a normalized particle age.
- 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.
- struct SizeStep A scale factor keyed to a normalized particle age.
- class Sprite Scene node that draws a single textured quad.
- class StaticHashMap Statically allocated hashmap with open addressing and leapfrog probing.
- struct StaticHashMapHelperTraits Primary template for the StaticHashMapIterator type traits helper.
- struct StaticHashMapHelperTraits<K, T, HashFunc, Capacity, false> Type traits used by the non-constant StaticHashMapIterator.
- struct StaticHashMapHelperTraits<K, T, HashFunc, Capacity, true> Type traits used by the constant StaticHashMapIterator.
- class StaticHashMapIterator Bidirectional iterator over the elements of a StaticHashMap.
-
struct Task Awaitable result of an asynchronous coroutine operation.
- struct task_promise
- class TextInputEvent Text input event.
- class Texture Image data uploaded to the GPU and sampled by shaders.
- class TextureFormat OpenGL pixel format 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.
- struct Pointer State of a single touch pointer.
- class UwpApplication Main entry point and handler for UWP (Universal Windows Platform) applications.
-
class VelocityAffector Affector that animates the velocity of a particle.
- struct VelocityStep A velocity offset keyed to a normalized particle age.
- class Viewport Render target with its own scene root, camera and render queue.
- class xxHash32Func xxHash3 hash function producing a 32-bit value
- class xxHash64Func xxHash3 hash function producing a 64-bit value
-
namespace Backends Platform-specific backends.