Classes
-
namespace Death Shared root namespace.
-
namespace Backward Exception handling and crash reporting implementation.
- class ExceptionHandling Unhandled exception handling.
- struct FaultDescription Description of the memory access that crashed the application.
- 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 SmallVectorIsTriviallyRelocatable Whether
Tis cheap enough to relocate with a bulk memory copy. - 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.
- class Sha256 Computes SHA-256 digest of data fed in parts.
- 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 partially supported Read-only streaming directly from Android asset files.
- class BoundedFileStream Provides only specified portion of the specified seekable input stream.
- class EmscriptenFilePicker partially supported Allows a user to pick files in the browser.
- class EmscriptenFileStream partially supported 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 FileStreamPool Keeps the open stream of one file between uses, so reading a resource does not reopen it.
-
class FileSystem File system related methods.
- class Directory Handles directory traversal, should be used as iterator.
- struct EntryInfo Properties of a directory entry, see Directory::
TryGetEntryInfo(). - class MapDeleter partially supported 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 and crash reporting 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 IlluminateLights Swarm of lights orbiting an illuminated collectible.
- struct Light
-
class IlluminateLights Swarm of lights orbiting an illuminated collectible.
- 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 CtfBase Capture The Flag base.
- class Flag Capture The Flag flag/base marker.
- class GameModeObjectActor Object of a game mode in the level.
- 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 RemoteElectroShot Remote representation of the electro shot in online session.
- class RemotePlayerOnServer Remote player in online session.
- class RemoteThunderbolt Remote representation of the thunderbolt in online session.
-
class StateInterpolationBuffer Interpolation buffer for actor positions received from a remote authority.
- struct StateFrame
-
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.
- struct LegacyFrame
- 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 CustomShot Shot of a custom weapon of the level.
- 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.
- struct MovementResult
- struct EventParamsReader Typed accessor over the raw event activation parameter buffer.
- struct EventParamsWriter Writes typed values into a packed event parameter buffer.
- class Explosion Explosion effects.
- class IActorUpdateOverride Takes over the per-frame update of an object.
-
class Player Represents a controllable player.
- struct CharacterTraits Constant per-character properties.
- struct InventoryState Collected items and weapon loadout of a player.
- class PlayerCorpse Represents a dead corpse of a player.
- class SolidObjectBase Base class of a (pushable) solid object.
-
namespace Bosses Enemy bosses.
-
namespace AssetPacker Offline data conversion tool, see Asset packing.
- class BigEndianWriter Builds a big-endian binary file in memory.
- class CartridgeImage Rewrites the game content of a Nintendo 64 ROM image.
- class ContentFilter Decides what of a tree of game content is left out of what is made for a target.
-
class DiscImage Rewrites the game content of a bootable console disc image.
- struct GameCubeImageDescription What a new GameCube disc image is made of, see CreateGameCubeImage().
- class FontPacker Converts bitmap fonts between the form they are authored in and the one the game loads.
-
class FormatVerifier Checks that every level and tile set in a directory survives being read and written again unchanged.
- struct FuzzOptions Limits and reproducibility of FuzzDirectory().
- class ISectorReader Reads the logical sectors of a data track, addressed by their absolute LBA.
- class ISectorSink Receives the logical sectors of a generated volume, in order from its first one.
- class Iso9660Builder Generates an ISO 9660 file system.
-
class Iso9660Reader Reads an ISO 9660 file system.
- struct Entry One entry of a directory.
- class LevelText Converts a level of the game's own format to text and back, for version control.
- class ModuleConverter Converts the game's Galaxy Music System modules (
.j2b) into FastTracker II modules (.xm). -
class Mpeg1Encoder Encodes planar YUV 4:2:0 frames into an MPEG-1 video elementary stream (
.m1v).- struct Options Encoding parameters.
- struct Statistics Statistics of the stream written so far.
-
class N64Content Turns a converted content tree into the formats the Nintendo 64 plays natively.
- struct Tools The converters the formats are produced with.
- class SpriteRepacker Re-lays out the hand-made sprite sheets that a platform would have to split.
- class TranslationFilter Leaves the texts of one context out of a compiled translation.
- struct Wav64Audio Audio to be written as a
.wav64, always as 16-bit samples. - class Wav64Writer Writes libdragon's
.wav64audio files. - class Xm64Converter Converts FastTracker II modules (
.xm) into libdragon's.xm64.
-
namespace Collisions Collision checking.
- struct CollisionPair A potentially overlapping pair of proxies reported by the broad-phase.
- class DynamicTree Dynamic AABB tree broad-phase.
- class DynamicTreeBroadPhase Broad-phase for collision detection.
-
struct TreeNode Node in the dynamic tree.
- union [union].__unnamed0__
-
namespace Compatibility Translation layer for original data files.
-
class AnimSetMapping Maps indices from original data file to organized entries.
- struct Entry Mapped entry.
-
class AssetConverter Converts original Jazz Jackrabbit 2 data into the formats the game loads.
- struct ConversionOptions What is converted out of the source directory, and what of it is carried over.
- struct LevelPackConversion How the levels of a level pack are converted, and what came out of it, see ConvertLevelPack().
- class ConversionProgress Reports how far a conversion of the original game files has got.
- struct ConversionResult Converted extended event description.
- class EventConverter Maps original events to extended event descriptions.
- class J2vRecompressor
- struct J2vVideoInfo Rewrites a
.j2vcinematic so weaker platforms can play it. -
class JJ2Anims Parses original
.j2aanimation files.- struct AnimFrameSection Frame of an animation as an animation file stores it.
- struct AnimSection Animation as an animation file stores it.
- class ImageContentDecoder Incremental decoder for the image content written by WriteImageContent.
- struct PackedFrame Where one frame ends up in a tightly packed sheet.
- struct PackedSheet Describes a tightly packed sheet, or nothing when the frames form a regular grid.
- 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.
- union [union].__unnamed0__
- 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 Editor
- namespace ActionIds Identifiers of the actions of the level editor.
- namespace EventCatalogParts
-
namespace Implementation
- class PlayTestLocalSession
- namespace StampClipboard Stamps as text in the clipboard of the system, so they can be pasted into another instance of the game.
- namespace TileMasks Collision masks of tiles packed a bit per pixel, as tile sets store them.
- namespace ToolActions Actions of the tools and of the selection, and what they do.
- namespace ToolMath Small helpers shared by the tools of the level editor and the smart tiles.
- namespace ToolTests Tests of the tools of the level editor and of the level it shows, run by EditorSelfTest.
- class ActionRegistry All actions of the level editor.
- struct AddTilesOptions How the tiles of an image are cut and matched to the colors, see AddTilesFromImageAsync().
-
struct Annotation A bookmark or a note placed in a level, for the editor only.
- struct Reply A reply to a note.
- class AnnotationCache Bookmarks and notes of a level, read again only when they change.
- class AutosaveService Keeps a copy of unsaved changes, so they aren't lost if the game ends unexpectedly.
- class BackgroundJob Work done off the user interface, on a thread of its own where the platform has threads.
- class BlockGrab Grabs a block of tiles as the stamp by its two corners marked with a key, as
Bof Jazz Creation Station. - class BrushTool Paints the stamp, or erases.
- struct CatalogText Text of a description of an event, a literal is shown as it is, a text translated by
_x()is kept. - class CommandArchive Keeps the history of changes in a recovery copy of a level, so they can be undone after it's restored.
-
class CommandHistory Undo and redo history of a level being edited.
- struct Entry
- class CompressedBuffer Data compressed by Deflate in memory.
-
class ContentTileSetLibrary Tile set library of the game content.
- struct Entry
- struct CustomWeaponTemplate Template of a custom weapon, read from a
.jsonfile inEditor/Weapons/. - struct DocumentAnimation An animated tile of a level being edited.
- class DocumentChanges Collects what changed in a level being edited.
- struct DocumentEvent An event of the grid, at a tile of the sprite layer.
-
class DocumentFiles The file of the level being edited and the files around it.
- struct WatchedTileSet
- struct DocumentLayer A layer of a level being edited.
- class DocumentSnapshot Parts of a level being edited, compressed in memory.
- struct DocumentTileArea Area of a layer whose tiles changed.
- struct DocumentViewState How a level was seen and played in the editor the last time, for the editor only.
- class EditCommand Undoable change of a level being edited.
- struct EditorAction Something the user can do in the level editor.
- class EditorCamera Camera of the level editor.
-
class EditorDebugConsole Commands to test the level editor without input, only in debug builds.
- struct Perf
- struct EditorIcons Vector art of the icons of the level editor, see UI::
Windows:: Icons. - struct EditorInitialization Tells the level editor what to open.
-
class EditorInputRouter Takes the keyboard, the mouse, the touch screen and the gamepad in the level editor.
- struct HeldAction
-
class EditorLevelHandler Shows a level being edited.
- struct FrameBlur
- class EditorSceneCanvas Canvas in the level, drawn among its layers in pixels of the level.
- class EditorSelfTest Self-test of the level editor, run by the
/editor-selftest [directory]command-line switch. -
class EditorSession The level editor.
- struct AppliedTile
-
struct EditorSettings Settings of the level editor, kept in
Jazz2.Editor.jsonin the configuration directory.- struct PanelPlacement Whether a panel that can be docked floats, and where it floated the last time, in units.
- struct PlayTestSettings Options of play-tests and of what is shown of them that are kept, see PlayTestController.
- struct TileSetFavorites Recently used and favourite tiles of a tile set, by their index in it.
- struct ToolOptions Options of the tools that are kept, see ToolSettings.
-
class EditorShell Interface of the level editor on a desktop.
- struct CachedPathSegment
- struct LinkEvent
- struct LinkGroup
- struct SelectionEdge
- struct SelectionRun
- struct ShownDialog
- class EditorTool Tool used in the view of the level editor.
- struct EpisodeFile An episode file (
.j2e) as the editor reads and writes it. - struct EpisodeImage Image of an episode, RGBA pixels row by row.
- struct EpisodeLevelInfo What the editor needs to know of a level of an episode without loading it.
- class EventCatalog All events the editor knows, how they are shown and how their parameters are edited.
- struct EventDescriptor Description of an event, how it's shown and how its parameters are edited.
- struct EventDirection An arrow of an event along the values of its parameters, see EventPreviews::
CollectDirections(). - struct EventExtensionError A description of an event from outside of the game that couldn't be used, see EventCatalog::
GetExtensionErrors(). - struct EventFindOptions Which events Find and Replace finds, see ReplaceEvents().
- struct EventGizmo A handle in the view that changes a parameter of an event by dragging it.
- class EventGizmos Finds the handles of events and changes their parameters by them.
- class EventGrid Events to choose from, as a grid of their pictures and names.
-
class EventInspectorPanel Properties of the selected events, or of the event to place when none is selected.
- struct PickTarget
- struct EventLightShape How a light event lights up its surroundings, see EventPreviews::
GetLight(). - struct EventLink A line between events linked by the values of their parameters, see EventPreviews::
CollectLinks(). - struct EventParamField Parameter of an event, a value stored in the 16 bytes of parameters of the event.
- class EventPickerPanel Panel with the events to choose from, by category.
- struct EventPreviewCase How an event looks for a value of one of its parameters, see EventDescriptor::
PreviewCases. -
class EventPreviews Draws events as the level editor shows them.
- struct BoxLabel
- struct DrawTarget
- struct ExtraPart
- struct SpriteEntry
- struct EventPreviewSpec How an event is drawn, as the object it spawns looks with its parameters.
- class EventSelection Selected events, of the event grid by their tiles and off the grid by their indices.
-
struct EventStamp Events the event tool places.
- struct Item An event of the stamp.
- struct OffGridItem An event of the stamp off the grid.
- class EventTool Places, selects, moves and erases events.
- class EyedropperTool Picks tiles of the layer as the stamp.
-
class FakeToolHost Host of the tools of the level editor for tests, only over a document and its history.
- struct PreviewedTile A tile shown before it's changed, see PreviewTile().
- struct RevertedArea An area shown again as the level has it, see RevertPreview().
- struct FieldMirror How a value changes when its event is mirrored one way.
- class FillTool Fills an area of the same tiles with the stamp.
- struct FiringRange The firing range the preview of a weapon shows.
-
class GroundLineTool Draws ground along a line, with slopes as steep as the line, and changes it later.
- struct Options
- struct OwnedOverlay
- struct SplineOverlay
- class HandTool Moves the view.
- class IDocumentEditor Changes the level being edited, see IToolHost.
- class IDocumentFilesHost What DocumentFiles needs of the level editor beyond IEditorContext.
- class IEditorContext What the panels and the dialogs of the level editor need from it.
- class IFeedback Tells the user about what happened, see IToolHost.
- class IInputRouterHost What EditorInputRouter needs of the level editor beyond IEditorContext.
- class ILevelView Shows the level being edited, see IToolHost.
- class InsertLayerCommand Adds a layer or removes one.
- class InspectorPanel Properties of the layer being edited.
- class IPlayTest A level being played from the editor, see PlayTestLevelHandler.
- class IPlayTestHost What a PlayTestController needs of the level editor that hosts it.
- class ISelectionHost Keeps what is selected and what the tools paint with, see IToolHost.
- class ITileSetLibrary Provides information about tile sets to a level being edited.
- class IToolHost What tools need from the level editor.
- class JobProgress How far work done off the user interface is, shared by the work and the window that waits for it.
-
struct LayeredStamp A rectangle of tiles of several layers with the events in it, copied and pasted as one.
- struct Layer Tiles of a layer.
- class LayerIdRemap Identities of this run of the editor for the layers kept by another one.
- class LayerResizeHandles Handles on the frame of the layer being edited that resize the layer when they're dragged.
-
class LayersPanel List of the layers of the level, with their visibility and lock.
- struct Thumbnail
- struct LayerView How a layer is shown in the view.
-
class LevelDocument A level being edited.
- struct OverrideRefs Tiles overridden by the level as tile references, see RemapTiles().
- struct LevelProblem A problem found in a level, see CheckLevel().
- struct LevelStatistics What a level has in a difficulty, counted from its events.
- struct LevelTextLanguageState Language of the translations shown in the dialog of the level texts.
- class LevelThumbnail Draws a level small, a pixel for a tile in the average color of the tile.
- struct LevelWeapons Weapons of a level as the editor changes them.
-
class MaskOverlay Shows the collision masks of a layer over the level.
- struct Chunk
-
class MeasureTool Measures distances in the level and shows how far the player jumps.
- struct JumpArc One of the jumps the tool shows.
- class MoveLayerCommand Moves a layer to another position in the list of layers.
- struct OkLab A color in the Oklab color space, where distances follow how different colors look.
- class PaletteFile Reads and writes palettes in the files other programs use, by their extension.
-
class PaletteMapper Finds the entries of a palette closest to colors, and remembers them.
- struct CacheEntry
-
class PaletteSearch Finds the entries of a palette that look the closest to colors.
- struct Entry
- struct ParamOption Option of a parameter of the type ParamType::Enum or ParamType::Flags.
-
class PathTool Places the event to place along a path, at even distances — a row or an arc of coins or gems.
- struct Options How the events are placed.
-
class PlayOverlays What is shown over the level being edited of how it's played.
- struct DeathSpot
-
struct PlayPath Path the player took in a play-test, for the editor to show.
- struct Segment Part of the path without a break.
- class PlayPathHistory Paths the player took in the last play-tests of a level.
- class PlayTestController Plays the level being edited, and returns to editing it.
- class PlayTestDebug Debug tools of a level played from the level editor.
- struct PlayTestDebugOptions Debug toggles of a level played from the level editor.
- class PlayTestDebugOverlay Draws debug information of a play-test over the level.
- class PlayTestLevelHandler Plays a level being edited.
- class PlayTestMpLevelHandler Plays a level being edited as multiplayer in local splitscreen.
- struct PlayTestOptions How a play-test starts.
- class PlayTestRootNode Node every object of a level is under, it updates them with the time of the play-test.
-
class PlayTransition Reveals the level being played from the editor in a growing ring.
- struct Band
- struct PngCodec Reads and writes PNG images for the editor.
- struct PoEntry Entry of a gettext catalog.
- class PoFile Reads and writes gettext catalogs,
.poand.potfiles. - struct PropertyChoice A value of a dropdown of fixed choices and the text it's shown with, see AddChoiceDropdown().
- class RectangleTool Fills a rectangle with the stamp.
- class RulesFile The rules of a tile set,
Tilesets/<name>.rules. - class RuntimeSync Brings the level shown by the editor up to date with the level being edited.
-
class SavedComparison Shows where the level being edited differs from its file saved on disk.
- struct SavedLayerDifference
- class ScriptGraphics The sprites the script of a level gives the objects of the events, so the editor shows them.
- struct ScriptParamChoice A named value of a parameter of a weapon of a script.
- struct ScriptParamValue Value of a parameter of a weapon of a script.
- struct ScriptWeaponClass A weapon a script library of JJ2+ offers, as MLLE sets it up.
- struct ScriptWeaponParam A parameter of a weapon of a script, in the order the library reads them.
- struct ScriptWeaponTemplate Description of a weapon of a script, its library and its parameters.
- class SelectTool Selects a rectangle of tiles.
- class SetAdditionalPaletteCommand Changes the colors of an additional palette of the level, as an undoable step.
- class SetAnimationCommand Changes the timing and the frames of an animated tile, the number of animated tiles stays the same.
- class SetChunkCommand Changes the payload of a chunk, as an undoable step.
-
class SetEventsCommand Changes events of the grid.
- struct Change Change of a single event.
- class SetLayerPropertiesCommand Changes the description or the name of a layer, its size stays the same.
- class SetLayerTextureCommand Replaces the texture of its own of a layer, or removes it, see DocumentLayer::
Texture. - class SetLevelPaletteCommand Changes the palette of the level, and whether the level uses it.
- class SetLevelPropertiesCommand Changes the level flags and properties.
- class SetLevelTilesCommand Changes the pixels or the masks of tiles the level stores in itself, see Formats::
ExtraTileSetRecord:: Embedded. -
class SetOffGridEventsCommand Changes the events placed off the grid, all of them at once.
- struct Hunk
- class SetTerrainSplinesCommand Changes the ground laid along lines and the tiles of its layer as one step.
-
class SetTileOverrideCommand Changes how the level overrides the pixels and the collision mask of a tile.
- struct State
-
class SetTilesCommand Changes tiles of a layer.
- struct Change Change of a single tile.
- class ShapeTool Draws a line, the outline of a rectangle, or an ellipse with the stamp.
- struct Shortcut Key and modifiers that run an action.
- struct SimulatedShot A shot of the firing range, frame by frame.
- class SmartBrushTool Paints ground, the tiles are chosen by the tiles around them.
-
class SmartTileModel Learns how the tiles of a tile set fit together, from the levels that use it.
- struct Candidate
- struct DocumentBand
- class SnapshotCommand Change of parts of a level kept as snapshots before and after it.
- class StampPreview The stamp of the brush, drawn small.
- class StatusBar Status bar at the bottom of the window.
- class StrokeTool Base of the tools that paint tiles.
- class TerrainCoverageView Shows which of the 47 ways the cells around can be solid have tiles to choose from.
- class TerrainRules Tiles chosen by hand for ground with given neighbors, instead of those learned from levels.
-
struct TerrainSpline Ground laid along a line, kept so it can be changed and laid again.
- struct OwnedTile Tile written by the ground, and what was there before.
- class TileGrid Tiles of a tile set to pick the stamp from.
- struct TileImportOptions How an image is made into a tile set, see SliceTileSet().
- struct TileImportResult What SliceTileSet() did.
-
class TileLod Draws the tile layers from far away as images instead of tiles.
- struct BlockCacheEntry
- struct Chunk
- struct Cover
- struct DrawnLayer
- struct PooledTexture
- struct TileBlock
- struct ViewCell
- class TilePickerPanel Panel with the tile grid and its controls.
- class TilePixelTool Paints the pixels of a tile right in the level, for the tile editor.
-
struct TilePrefab A stamp of tiles kept with a tile set under a name, to paint it in any level of the tile set.
- struct LayerTiles Tiles of another layer.
- struct PrefabEvent Event of a prefab.
- struct Tile Tile of a prefab.
- struct TileRef Reference to a tile of a level being edited.
- class TileSelection Selected tiles of a layer.
-
class TileSetDataCache Tile sets read whole, for the pixels and the masks of their tiles.
- struct CachedTileSet
-
class TileShapes Shapes of the collision masks of the tiles of a tile set.
- struct LevelTiles Tiles a level stores in itself, an extra tile set embedded in it.
- struct Surface Tile of ground with a straight surface.
- struct TileSource The tile set a source of tiles of a level takes them from, see ResolveTileSource().
-
struct TileStamp Tiles the brush paints with.
- struct OffGridEvent An event of the stamp off the grid, see OffGridEvents.
- struct TileTarget Where tiles are added to.
- class ToolManager Keeps the tools and which of them is used.
- struct ToolOptionItem A value of an option of a tool, or a toggle, see ToolOptionsBuilder.
-
class ToolOptionsBar Options of the tool chosen, in the toolbar, see EditorTool::
BuildOptions(). - struct Item
- class ToolOptionsBuilder Makes the options of a tool, shown in the toolbar while the tool is chosen, see EditorTool::
BuildOptions(). - struct ToolPointer Pointer over the view, as a tool sees it.
- struct ToolSettings Options shared by the tools, kept with the settings of the editor.
-
class TouchGestures Tells what the fingers on a touch screen do in the level editor.
- struct Finger
- class UpdateWatcher Takes no room, only calls a function every frame.
- class WandTool Selects an area of the same tiles.
- class WeaponPreview Preview of a custom weapon in a firing range.
- class WeaponSpriteView An animation of a weapon in a small box, as it plays in the game.
- struct WeaponTemplateImage An image a template of a custom weapon takes from a PNG file next to it, with how its frames are laid out.
- struct WebFileBridge Moves files between the level editor and the computer the browser runs on.
-
namespace Events Events and object spawning.
-
class EventMap Represents event map, spawns triggered objects.
- struct DifficultyEvent The events of the grid that aren't of every difficulty, sorted by the tile, see GetEventDifficulty().
- struct DifficultyEventInfo Event meant only for the easy or only for the hard difficulty, see CollectEasyOrHardEvents().
- class EventLayout The event layout: a 16-bit slot per tile, the tiles that hold an event in a dense array.
- struct EventTile Represents an event tile.
- struct SkippedDifficultyEvent Easy-only and hard-only events left out in the current difficulty, with all they need to be put back.
- class EventSpawner Spawns objects in a level.
-
class EventMap Represents event map, spawns triggered objects.
-
namespace Formats The game's own level and tile set formats.
- struct AnimatedTileRecord An animated tile.
- struct ChunkRecord Optional tagged data at the end of the body.
- struct EventRecord An event placed in a level.
- struct ExtraTileSetRecord Extra tile set used by a level.
-
struct LayerPropertiesChunk Chunk with what the records of the layers have no room for.
- struct Entry Properties of one layer.
- struct LayerRecord Description of a layer.
- struct LevelFile Layout of the game's own level format.
- struct LevelHeader Uncompressed header of a level file.
-
struct LevelPreview Preview of a level shown in the list of custom levels, see LevelFile::
PreviewChunk. - class ISource Layers of a level and the pixels of their tiles, as the preview takes them.
-
class RecordSource A level in the form its file stores it, with its tile sets in memory.
- struct Layer Layer with its tiles.
- struct TileSet Tile set the tiles of the level are taken from, see ExtraTileSetRecord.
- class StartPicker Picks the start of a level the preview is made around.
- struct TilePixels Pixels of a tile as stored in its tile set.
- struct LevelProperties Level properties, the first section of the body.
- class LevelReader Reads the body of a level, section by section.
-
struct LevelSettingsChunk Chunk with the settings of a level that its properties have no room for.
- struct Settings Settings of a level.
- struct LevelTextsChunk Chunk with the texts of a level translated to other languages.
- class LevelWriter Writes a level, section by section.
- struct OffGridEventRecord An event placed at any position, not aligned to the tile grid.
- struct PaletteRecord Named palette of a level.
- struct ScriptDataChunk Chunk with the data of a level for its script.
- struct TexturedLayerParams Parameters of a textured layer that the color of its record has no room for.
- struct TileDiffuseOverride Tile with a diffuse overridden by the level.
- struct TileMaskOverride Tile with a collision mask overridden by the level.
- struct TileRecord A tile of a layer, or a frame of an animated tile.
- struct TileSetData A whole tile set as its file stores it.
- struct TileSetFile Layout of the game's own tile set format.
- struct TileSetHeader Uncompressed header of a tile set file.
- struct WeaponsChunk Chunk with the weapons of a level.
-
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 LevelPacks
- struct LevelPackEpisode A converted episode of a level pack.
- struct LevelPackFile One original file of a level pack.
- struct LevelPackInfo What is known about a pack before it's installed.
- struct LevelPackLevel A converted level of a level pack.
- class LevelPackLibrary Installed level packs.
- struct LevelPackManifest Record of an installed level pack.
-
namespace Multiplayer Multiplayer-related classes, compiled only if
WITH_MULTIPLAYER.-
namespace GameModes Rules and HUD of the particular multiplayer game modes, compiled only if
WITH_MULTIPLAYER.- class BattleMode Battle game mode (free-for-all).
- struct CapturePointInfo Control point or capture point of the level, see IGameModeContext::
FindCapturePoints(). - class CaptureTheFlagMode Capture The Flag game mode.
- class CooperationMode Cooperation game mode.
- class CustomGameModeBase Common base of the game modes that score points of their own.
- class DeathCaptureTheFlagMode Death Capture The Flag game mode (team-based).
-
class DominationMode Domination game mode (team-based).
- struct ControlPoint
- class ExtendedLastRabbitStandingMode Extended Last Rabbit Standing game mode (free-for-all).
- class FlagRunMode Flag Run game mode (team-based).
- struct GameEndResult Result of IGameMode::
CheckGameEnds. - class GameModeBase Base of all game modes.
- struct GameModeObject Object in the level owned by a game mode.
- class HeadHuntersMode Head Hunters game mode (team-based).
- class IGameMode Rules of a single multiplayer game mode.
- class IGameModeContext Services a game mode needs from its host level handler.
- class IGameModeHUD Drawing surface a game mode uses to render its own part of the HUD.
-
class JailbreakMode Jailbreak game mode (team-based).
- struct Jail
- class LastRabbitStandingMode Last Rabbit Standing game mode (free-for-all).
- class PestilenceMode Pestilence game mode (free-for-all).
- class RaceMode Race game mode.
- struct RespawnDecision Result of IGameMode::
DecideRespawn. - class RoastTagMode Roast Tag game mode (free-for-all).
- class TeamBattleMode Team Battle game mode.
- class TeamLastRabbitStandingMode Team Last Rabbit Standing game mode (team-based).
- class TeamRaceMode Team Race game mode.
- class TeamTreasureHuntMode Team Treasure Hunt game mode.
- class TreasureHuntMode Treasure Hunt game mode.
- struct AllPeersT All connected peers tag type.
- struct AntiCheatState Server-side anti-cheat state of a peer.
- 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 a multiplayer game session (online or local splitscreen).
- struct PlayerScore Single row of the multiplayer scoreboard.
- struct RoundResult Single row of the final round standings.
- struct MpPlayerState Network-agnostic per-player game-mode state for a single round.
- struct MultiplayerSpawnPoint Spawn point in a multiplayer level.
- class NetworkManager Manages game-specific network connections.
-
class NetworkManagerBase Allows to create generic network clients and servers.
- struct ConnectionStatistics Quality of the connection to the server.
- struct KickedPeer Peer kicked by the server, waiting for its disconnect to be reported.
- struct Peer Remote peer as opaque handle.
- struct PeerDescriptor Peer descriptor.
- struct PlaylistEntry Playlist entry in ServerConfiguration.
- struct RaceCheckpoint Checkpoint on the track through a level.
- 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.
- struct ServerMessage Message of the server with its arguments, see ServerMessageType.
- struct ServerMessageArg Argument of ServerMessage.
- struct ServerMessageTeam Team index passed to ServerMessage.
-
class WebhookClient Posts selected server events to a configured webhook.
- struct EmbedField
- struct LeaderboardEntry Single row of a leaderboard included in a webhook notification.
-
namespace GameModes Rules and HUD of the particular multiplayer game modes, compiled only if
-
namespace Rendering Scene rendering and viewport management.
- namespace SoftwareLighting
- 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.
- struct WaterView What the water needs, in the pixels of the view, shared by the combine pass and the water in the middle of the scene.
- class PolylineRenderer Draws thick antialiased polylines.
-
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).
- class WaterRenderer Draws the water in front of a layer behind the others.
-
class XRayMaskRenderer Renders the coverage of the actors behind the x-ray tile layers.
- struct Group
-
namespace Resources Structures for game resources.
- struct DeferredGraphicResource Description of a graphic resource that is loaded on first use.
- struct Episode Describes an episode.
- struct FrameRect Placement of a single frame in a tightly packed sprite sheet.
- struct GenericGraphicResource
- 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 AnimationTables Animation tables of the level scripts of JJ2+,
jjAnimSets,jjAnimationsandjjAnimFrames. - class EventTranslator Translates the events of a level between the game and the original, for the level scripts of JJ2+.
- 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 What drives an object every tick.
- struct jjCANVAS Drawing surface passed to the HUD and layer drawing hooks.
- class jjCHARACTER Character profile.
- class jjCOLORMAP Editable 32-bit image with alpha.
- struct jjCONTROLPOINT Control point of Domination, read only, an unused one is empty and neutral.
-
class jjLAYER Layer of tiles.
- struct TextureStyleParams Parameters of one texture style of a layer, the object behind
jjLAYERWARPHORIZONand the others.
- struct TextureStyleParams Parameters of one texture style of a layer, the object behind
- class jjMASKMAP Editable collision mask of a tile.
-
class jjOBJ An object of the level.
- struct SyncedState
- class jjPAL A palette of 256 colors.
- struct jjPALCOLOR A single color of a palette or a 32-bit image.
-
class jjPARTICLE A simple visual effect in the level.
- union [union].GENERIC Type-specific particle data, interpreted according to particleType.
- 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 Editable 8-bit image.
- class jjPLAYER partially supported A player in the level.
- struct jjPLAYERDRAW How a player is drawn in this tick.
- class jjRNG A seedable pseudo-random number generator.
- class jjSTREAM A buffer of bytes for storing data and exchanging it with files.
- struct jjTEXTAPPEARANCE Layout and styling options for drawn text.
- class jjTILE A tile of the level, static or animated.
- struct PresetAnimation Animations the template of the objects of an event has in JJ2+ before a script changes them.
- class ScriptEventObject Object of an event the game has no object of (EventType::
PassthroughEvent). - class ScriptLayerCanvas Where
onDrawLayer1()toonDrawLayer8()of a level script draw. - class ScriptObjectHost Drives an object of the game by a behavior of a level script, as JJ2+ does with the objects whose template (
jjObjectPresets) has a behavior of the script. - class ScriptSceneryObject Destructible scenery as an object of the game, for a level script that drives it.
-
class ScriptWorldCanvas Sprites and rectangles a level script draws in the level (
jjDrawSprite()and the like).- struct SolidDraw Rectangle of a color of the palette drawn in the level.
- struct SpriteDraw Frame of a sprite drawn in the level.
- struct TextDraw Text drawn in the level.
- struct TileDraw Tile drawn in the level.
- class AnimationTables Animation tables of the level scripts of JJ2+,
- 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.
- struct ActorSwap
- struct BehaviorMethods Methods of a class of a script that implements
jjBEHAVIORINTERFACE,nullptrfor the ones it doesn't have. - struct EventWrite
- struct FiringBullet
- struct LoopedSample
- struct ObjectSlot
- struct PlusTexture
- struct ScriptTileSetPixels
- struct SpriteModeMapping
- struct StartingLook How a new object of an event looks, see GetStartingLook().
- struct WrittenEvent
- 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 Tests Measurement harnesses, compiled only if
WITH_PHYSICS_PROBE.- class PhysicsProbe Drives the first player through a fixed matrix of movement scenarios and logs its trajectory.
-
namespace Tiles Tile sets and maps.
- struct AnimatedTile Represents an animated tile.
- struct AnimatedTileFrame Represents a single frame of an animated tile.
- class ITileMapLayerOverride Draws images in place of the tiles of layers, as the level editor does for a view from far away.
- class ITileMapOwner Interface used to notify tile map owner of various events.
- struct LayerDescription Describes the configuration of a tile map layer.
- struct LayerEffectsTarget What the special tile layers need from the viewport they are drawn in.
- class LayerLayout Tiles of a single TileMapLayer, in blocks and in one of two forms.
- struct LayerTile Represents a single tile placed 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 LayerPaletteRow
- struct LayerPass
- struct TileCommandUniforms Cached instance-block uniforms of one pooled per-tile render command.
- struct TileMapLayer Represents a single tile map layer.
- struct TileMapLayerImage An image drawn in place of the tiles of a layer, see ITileMapLayerOverride.
- struct TileMapViewOptions Options of how a tile map is shown.
- 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 Easing Easing functions.
- namespace MenuLayout Metrics of the menu layout that follow the size of the view.
- namespace Resources Common menu resources defined in
Metadata/UI/MainMenu.res. - class AboutSection About menu section.
- struct AnimatedValue Self-advancing animated scalar.
- class BeginSection Main menu root section.
- class CanvasWidget Row drawn entirely by a caller-provided callback.
- class ChoiceItem Setting row that cycles through values.
- class ControlsOptionsSection Controls options menu section.
- class CreateLocalGameOptionsSection Local splitscreen game options menu section.
- class CreateServerOptionsSection Create server options menu section.
- class CustomLevelSelectSection Custom level selection menu section.
- class CustomValueItem Setting row with a custom-drawn value.
- 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 LevelPackDetailSection Menu section of one installed level pack.
- class LevelPacksSection Level packs menu section.
- class ListContainer Base of vertical lists of selectable children.
- class ListItem Selectable text item.
- class MainMenu Main menu.
- class MenuContainerBase Shared base of the menu containers.
- class MenuSection Base class of a menu section.
- struct MenuStyle Centralized look-and-feel of the menu.
- class MenuTransition Drives an animated transition between two menu sections.
- 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.
- struct RowLayout Horizontal layout of the action rows, see GetRowLayout().
- class RescaleModeSection Rescale mode selection menu section.
- class SafeAreaOptionsSection Safe area options menu section.
- class ScoreboardSection In-game multiplayer scoreboard.
- class ScrollView Vertical list that scrolls when its children overflow the available area.
- class ServerSelectSection Server selection menu section.
- class SimpleMessageSection Section showing a simple message.
- class Slider Setting row with a value bar adjusted left/right.
- class SoundsOptionsSection Sounds options menu section.
- class StackLayout Vertical list that centers its children within its bounds.
- class StartGameOptionsSection Start game options menu section.
- class TextInput Editable text row.
- 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.
- struct ChromeLayout Where the section's own bar and its controls sit.
- struct TransitionInfo Parameters of a section transition.
- class UserProfileOptionsSection User profile options menu section.
- class Widget Base class of a menu widget.
- struct WidgetInput Snapshot of navigation actions newly pressed this frame.
- class WidgetSection Base class of a declarative menu section.
-
namespace Multiplayer Multiplayer-related user interface, compiled only if
WITH_MULTIPLAYER.-
class MpHUD Player HUD for multiplayer.
- struct MinimapDot
- class MpInGameCanvasLayer In-game canvas on sprite layer for multiplayer.
- class MpInGameLobby In-game lobby screen for multiplayer.
-
class MpHUD Player HUD for multiplayer.
-
namespace Windows Toolkit of windows, panels and controls, compiled only if
WITH_UI_WINDOWS.- class Button Button with a text, an icon or both.
- class CheckBox Check box with a text.
- class ColorPicker Picks a color by its saturation and value in a square, its hue in a bar next to it, and optionally alpha.
- class ColorSwatch Shows a color, a translucent one over a checkerboard.
- struct Context What the interface is measured with.
- class DetachedWindow Window of the system an element of the interface is shown in, outside of the main window.
- class Dialog Window shown over the interface with a title, content and buttons.
- class DockFrame Panel that is docked at an edge of the screen or floats over everything else.
- class DragBar Row that moves what it belongs to when dragged, such as the title of a window.
- class Dropdown Shows a value and opens a menu to choose another one.
- class Element Element of the interface.
-
class FileDialog Picks a file to open or to save to.
- struct Entry
-
struct FileInfo What a file dialog shows about the selected file next to the list, see FileDialog::
InfoFunc. - struct Row Row of a label and its value.
- struct FileKind How a file is shown in the list of a file dialog, see FileDialog::
KindFunc. - struct FileRoot Place where files are looked for.
- struct FileSpecialEntry Row at the top of the list of a file dialog that stands for a value instead of a file, see FileDialog::
SetSpecialEntries(). - class Form Rows of a label and what it's about, with the labels in a column as wide as the longest of them.
- class FormRow Row of a Form.
- struct IconArt How an icon is drawn, vector art or pixel art.
- class IconId Icon of the interface, a StockIcon or one of an application.
- class Icons Icons of the interface, those every interface has and those an application registers.
- struct IsIconEnum Tells whether an enum of an application holds icons, so it converts to IconId.
- struct IsIconEnum<Editor::EditorIcon>
- class Label Text.
- class MenuBar Menu bar at the top of the window.
- class MenuBarItem Item of the menu bar, opens its menu.
- struct MenuEntry Item of a menu.
- class MenuRow Row of a menu.
- struct MessageDialog Shows a message with a choice of buttons.
- class NumberBox Number that can be dragged or typed.
- class OnScreenKeyboard Keyboard on the screen, for a gamepad or a touch screen where the system has none.
- struct OverlayOptions How an element shown over the interface behaves.
- class Painter Draws the interface.
- class PaletteGrid The 256 entries of a palette in a grid of 16 × 16, to pick one of them, or a range of them.
- class Panel A stack with a background.
- struct PointerEvent A pointer — the mouse, a finger or a virtual cursor — over the interface.
- class PopupMenu Menu shown over the interface.
- class RadialMenu Menu of items in a ring around a point, as the weapon wheel of the game.
-
class ReadableFont Readable font of the interface, drawn from an outline font at the size text has.
- struct Entry
- struct ResizeEdges Edges a window is resized by, for the windows that can be.
- class ScrollView Shows a part of its content and lets the rest be scrolled to.
- class Separator Line between parts of a panel.
-
class Skin Texture the interface is drawn with.
- struct NineSlice Part of a texture drawn as nine slices, its corners keep their size.
- class Splitter Edge of a panel that is dragged to resize it.
- class Stack Places its children in a row or a column.
-
class Surface Shows the interface and passes input to it.
- struct DetachableElement
- struct Detachment
- struct Overlay
- struct RasterSkin
- struct Toast
-
class TextBox Single line of text that can be edited.
- struct EditState
- struct Theme Colors and sizes of the interface.
- struct Thickness Space around the content of an element, in units.
- class VectorArt Vector art described as text, drawn into pixels at any size.
- class VirtualList List of rows of the same height that draws only the rows that are seen.
-
class WrappedLabel Text on as many lines as it needs in the width it gets.
- struct WrappedLines
-
class Canvas Canvas.
-
struct GlyphBatch Glyphs of one font, shader and layer, written straight into batched commands.
- struct RetainedChunk Batch of a record with its instances in memory kept from frame to frame, see CANVAS_RETAINED_DRAWS.
- struct QuadBatch Rectangles of one layer drawn one after another, written straight into batched commands.
-
struct StringMemo What a string was drawn with by Font::
DrawString() and where its glyphs went. - struct TextureMemo What a rented command was set up with by DrawTexture(), every argument and everything of the canvas that goes into it.
-
struct GlyphBatch Glyphs of one font, shader and layer, written straight into batched commands.
-
class Cinematics Handler that plays a cinematic video.
- class ChunkedStream Reads one of the four interleaved compressed streams of a ".j2v" file from the source file.
- class FileWindow Sliding window over the video file, shared by the four compressed streams.
- struct StreamBuffer Buffers the decompressed output of one of the four streams.
- class VideoReader Sequential read-ahead of the native format, kept topped up while the video plays.
-
class DiscordRpcClient Allows interactions with running Discord client.
- struct RichPresence Rich presence description.
- class Font Bitmap font renderer.
-
struct FontFormat On-disk layout of a packed font.
- struct Glyph Metrics of a single glyph.
- 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.
-
class PerformanceOverlay Table of the detailed performance metrics.
- struct ColumnWidth
- struct Row
- class TableCanvas
-
namespace Menu Menu implementation.
-
namespace Utils Files written safely, JSON files and ZIP archives, compiled only if
WITH_EDITORorWITH_LEVEL_PACKS.- namespace JsonAccess Reads values from JSON that came from outside the game, without trusting their types.
- class AtomicFile Writes a file so that a failed write never damages the file that was there.
- class JsonFile Reads and writes JSON files that hold a single object.
- class ZipArchive Reads a ZIP archive.
- struct ZipEntry One file or directory in a ZIP archive.
- class ZipFormat Constants and conversions of the ZIP format shared by ZipArchive and ZipWriter.
-
class ZipWriter Writes a ZIP archive.
- struct Entry
- struct CharacterProfile Abilities of a character.
- struct ContentFileType Type tag written into the header of each file the game produces.
-
class ContentResolver Manages loading of assets.
- struct AuraHeader
- class LoadingScope Scope that marks a load, pairing BeginLoading() with EndLoading().
- struct SpriteSheet Sprite sheet of a graphics asset (
.aura) as it's stored, see ReadSpriteSheet(). - struct StringRefEqualTo
- struct WeaponSoundEntry
- struct CustomWeaponOptions How a custom weapon fires and what, and how it looks, only a custom weapon has it.
- 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 ViewportSetup How the viewports of the level are rendered, see GetViewportSetup().
- struct LevelInitialization Level initialization parameters.
- struct LevelLoadOptions Options of loading a level.
- struct LightEmitter Allows objects to emit light.
- struct LocalizedLevelTexts Texts of a level translated to one language.
- struct PlayerCarryOver Player carry over between levels.
- class PreferencesCache Provides access to a user preferences.
- struct TouchButtonLayout Per-button layout stored in user preferences.
- struct VideoFormat Layout of the game's own cinematic format.
- struct WeaponDefinition What a level makes of one of the weapons.
- struct WeaponEditorData What a level keeps of a weapon only for the editor.
- struct WeaponFireOptions How a custom weapon fires.
- struct WeaponImage Image of a custom weapon, a sheet of frames in rows and columns.
- struct WeaponOptions Options of a weapon a level can change, as JJ2+ scripts know them.
- struct WeaponsDescription Weapons of a level.
- struct WeaponShotOptions Shot of a custom weapon.
- struct WeaponSound Sound of a custom weapon, a file kept in the level.
- struct WeaponSprite Sprite of a custom weapon.
-
namespace Actors Implementation of all objects.
-
namespace nCine Root namespace of nCine game engine.
- namespace AudioMixer
-
namespace Backends Platform-specific backends.
- namespace OgcDvd The GameCube disc, mounted read-only as.
- namespace OgcMemoryCard GameCube memory cards, as the devices.
- namespace OgcStorage Storage of the GameCube that is not the disc — the SD cards in a memory-card slot or in the serial port under the console.
- namespace Ps2Modules PS2SDK's IOP modules, carried inside the executable rather than read from storage.
- namespace Ps2Storage Removable block storage on the PlayStation 2 - a USB stick, or an SD card in an MX4SIO adapter.
- 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 the screen (software) keyboard.
- 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 DcPlatform Dreamcast platform helpers on top of KallistiOS.
- class EglGfxDevice The EGL-based graphics device.
- class GlfwAuxiliaryWindow Window besides the main one made with GLFW, see AuxiliaryWindow.
- 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 LibretroApplication Application driven by a libretro frontend.
- struct HostPaths Directories advertised by the frontend, filled in before the initialization.
- class LibretroGfxDevice Graphics device presenting through the libretro frontend.
-
class LibretroInputManager Input manager exposing the RetroPad of the frontend as a standard mapped gamepad.
- class RetroJoystickState
- class RetroKeyboardState
- class RetroMouseState
- class N64FullMotionVideo Plays the Nintendo 64's full-motion video cinematics.
- 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 Qt5MouseState Information about Qt5 mouse state.
- class Qt5ScrollEvent Information about a Qt5 scroll event.
- class SdlAuxiliaryWindow Window besides the main one made with SDL, see AuxiliaryWindow.
- 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.
-
namespace RHI Render Hardware Interface — compile-time-selectable graphics backend abstraction.
-
namespace D3D11 Direct3D 11 backend, selected by
WITH_RHI_D3D11.- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- class D3D11Attribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class D3D11BufferObject Buffer object of the Direct3D 11 backend (aliased as
RHI::Buffer). -
struct D3D11CBufferSlot Describes one constant buffer slot a shader stage expects, precomputed from bytecode reflection.
- struct GlobalVar
-
class D3D11Debug Debug-output and object-labelling stub of the Direct3D 11 backend.
- class ScopedGroup RAII scope for a debug message group (a no-op for the Direct3D 11 backend).
-
class D3D11Device Pipeline-state and draw-call facade of the Direct3D 11 backend (aliased as
RHI::Device).- struct BlendingState
- struct BlendStateEntry
- struct CachedRect
- struct CullFaceState
- struct DepthTestState
- struct PooledCBuffer
- struct RasterStateEntry
- struct ScissorState
- struct UniformRange
- class D3D11Framebuffer Framebuffer stub of the Direct3D 11 backend (aliased as
RHI::Framebuffer). - class D3D11Renderbuffer Renderbuffer stub of the Direct3D 11 backend (aliased as
RHI::Renderbuffer). - class D3D11RenderTarget Off-screen render target of the Direct3D 11 backend (aliased as
RHI::RenderTarget). - class D3D11RhiCapabilities Runtime capabilities of the Direct3D 11 backend.
- class D3D11Shader Shader-object stub of the Direct3D 11 backend.
-
class D3D11ShaderProgram Shader program of the Direct3D 11 backend (aliased as
RHI::ShaderProgram).- struct ResolvedUniform
- class D3D11ShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class D3D11ShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). - class D3D11Texture Texture object of the Direct3D 11 backend (aliased as
RHI::Texture). - class D3D11Uniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class D3D11UniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class D3D11UniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class D3D11UniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - class D3D11VertexArray Vertex array object stub of the Direct3D 11 backend (aliased as
RHI::VertexArray). -
class D3D11VertexFormat Vertex layout description of the Direct3D 11 backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
-
namespace GL OpenGL 3.3 core, OpenGL|ES 3.0/2.0 and WebGL 2.0 backend, selected by
WITH_RHI_GL.- 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 GLDevice Pipeline-state and draw-call facade of the OpenGL backend.
- struct BlendingState Snapshot of the blending state, used to save and restore it around a draw.
- struct CullFaceState Snapshot of the face culling state, used to save and restore it around a draw.
- struct DepthTestState Snapshot of the depth test state, used to save and restore it around a draw.
- struct ScissorState Snapshot of the scissor test state, used to save and restore it around a draw.
- 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 GLRenderTarget Off-screen render target of the OpenGL backend.
- class GLRhiCapabilities Runtime capabilities of the OpenGL family backend.
-
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.
- struct GLTextureFormat Translates backend-neutral pixel formats into OpenGL formats.
- 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.
-
namespace GS PlayStation 2 fixed-function Graphics Synthesizer backend, selected by
WITH_RHI_GS.- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- class GsAttribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class GsBuffer Host-memory buffer object of the GS backend (aliased as
RHI::Buffer). -
class GsDebug Debug-output and object-labelling stub of the GS backend.
- class ScopedGroup RAII scope for a debug message group (a no-op for the GS backend).
-
class GsDevice Pipeline-state and draw-call facade of the GS backend (aliased as
RHI::Device).- struct BlendingState
- struct ClutSlot One resident CLUT: a 1 KB slab slot holding 256 entries of one palette row.
- struct CullFaceState
- struct DepthTestState
- struct PendingSoftwareLight
- struct ScissorState
- struct UniformRange
- class GsFramebuffer Framebuffer stub of the GS backend (aliased as
RHI::Framebuffer). - class GsRenderbuffer Renderbuffer stub of the GS backend (aliased as
RHI::Renderbuffer). - class GsRenderTarget Off-screen render target of the GS backend (aliased as
RHI::RenderTarget). - class GsRhiCapabilities Runtime capabilities of the Graphics Synthesizer backend.
- class GsShader Shader-object stub of the GS backend.
-
class GsShaderProgram Shader program of the GS backend (aliased as
RHI::ShaderProgram).- struct DispatchFacts Facts of the program the draw dispatch reads on every command, resolved once at introspection.
- struct ResolvedUniform
- class GsShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class GsShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). - class GsStagingBuffer Main-memory scratch a GIF transfer can be issued from.
-
class GsTexture Texture object of the GS backend (aliased as
RHI::Texture).- struct BakedSlot
- class GsUniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class GsUniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class GsUniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class GsUniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - class GsVertexArray Vertex array object stub of the GS backend (aliased as
RHI::VertexArray). -
class GsVertexFormat Vertex layout description of the GS backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
- class GsVram Page allocator for the Graphics Synthesizer's 4 MB of local memory.
- struct GsVramLayout Static layout of the Graphics Synthesizer's local memory, as requested by the device.
-
namespace GU PlayStation Portable fixed-function GU backend, selected by
WITH_RHI_GU.- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- class GuAttribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class GuBuffer Host-memory buffer object of the GU backend (aliased as
RHI::Buffer). -
class GuDebug Debug-output and object-labelling stub of the GU backend.
- class ScopedGroup RAII scope for a debug message group (a no-op for the GU backend).
-
class GuDevice Pipeline-state and draw-call facade of the GU backend (aliased as
RHI::Device).- struct BlendingState
- struct CullFaceState
- struct DepthTestState
- struct PendingSoftwareLight
- struct ScissorState
- struct UniformRange
- class GuFramebuffer Framebuffer stub of the GU backend (aliased as
RHI::Framebuffer). - class GuRenderbuffer Renderbuffer stub of the GU backend (aliased as
RHI::Renderbuffer). - class GuRenderTarget Off-screen render target of the GU backend (aliased as
RHI::RenderTarget). - class GuRhiCapabilities Runtime capabilities of the GU backend.
- class GuShader Shader-object stub of the GU backend.
-
class GuShaderProgram Shader program of the GU backend (aliased as
RHI::ShaderProgram).- struct DispatchFacts Facts of the program the draw dispatch reads on every command, resolved once at introspection.
- struct ResolvedUniform
- class GuShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class GuShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). -
class GuTexture Texture object of the GU backend (aliased as
RHI::Texture).- struct BakedStore
- struct Page One GE-addressable piece of the texture.
- class GuUniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class GuUniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class GuUniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class GuUniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - class GuVertexArray Vertex array object stub of the GU backend (aliased as
RHI::VertexArray). -
class GuVertexFormat Vertex layout description of the GU backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
-
namespace GX Nintendo Wii and GameCube fixed-function GX backend, selected by
WITH_RHI_GX.- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- class GxAttribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class GxBuffer Host-memory buffer object of the GX backend (aliased as
RHI::Buffer). -
class GxDebug Debug-output and object-labelling stub of the GX backend.
- class ScopedGroup RAII scope for a debug message group (a no-op for the GX backend).
-
class GxDevice Pipeline-state and draw-call facade of the GX backend (aliased as
RHI::Device).- struct BlendingState
- struct CullFaceState
- struct DepthTestState
- struct PendingSoftwareLight
- struct ScissorState
- struct TlutSlot
- struct UniformRange
- class GxFramebuffer Framebuffer stub of the GX backend (aliased as
RHI::Framebuffer). - class GxRenderbuffer Renderbuffer stub of the GX backend (aliased as
RHI::Renderbuffer). - class GxRenderTarget Off-screen render target of the GX backend (aliased as
RHI::RenderTarget). - class GxRhiCapabilities Runtime capabilities of the GX backend.
- class GxShader Shader-object stub of the GX backend.
-
class GxShaderProgram Shader program of the GX backend (aliased as
RHI::ShaderProgram).- struct DispatchFacts Facts of the program the draw dispatch reads on every command, resolved once at introspection.
- struct ResolvedUniform
- class GxShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class GxShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). -
class GxTexture Texture object of the GX backend (aliased as
RHI::Texture).- struct BakedSlot
- class GxUniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class GxUniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class GxUniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class GxUniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - class GxVertexArray Vertex array object stub of the GX backend (aliased as
RHI::VertexArray). -
class GxVertexFormat Vertex layout description of the GX backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
-
namespace GX2 Nintendo Wii U backend driving the Latte GPU through GX2 natively, selected by
WITH_RHI_GX2.-
namespace Gx2Memory GPU-visible memory of the GX2 backend.
- struct Block One allocation;
Baseis both the CPU and the GPU address.
- struct Block One allocation;
- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- class Gx2Attribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class Gx2BufferObject Buffer object of the GX2 backend (aliased as
RHI::Buffer). -
class Gx2Debug Debug-output and object-labelling facade of the GX2 backend.
- class ScopedGroup RAII scope for a debug message group (inert on this backend).
-
class Gx2Device Pipeline-state and draw-call facade of the GX2 backend (aliased as
RHI::Device).- struct AppliedTarget What was last programmed on the GPU, so a draw re-sends only what changed (the pipeline sets the viewport before every draw);
AppliedColorBuffer == nullptrmeans unknown, after the state was reset. - struct BlendingState
- struct CullFaceState
- struct DepthTestState
- struct RetiredBlock A retired block together with the frame it stopped being referenced in.
- struct ScissorState
- struct UniformRange
- struct AppliedTarget What was last programmed on the GPU, so a draw re-sends only what changed (the pipeline sets the viewport before every draw);
- class Gx2Framebuffer Framebuffer stub of the GX2 backend (aliased as
RHI::Framebuffer). - class Gx2Renderbuffer Renderbuffer stub of the GX2 backend (aliased as
RHI::Renderbuffer). - class Gx2RenderTarget Off-screen render target of the GX2 backend (aliased as
RHI::RenderTarget). - class Gx2RhiCapabilities Runtime capabilities of the GX2 backend.
- class Gx2Shader Shader-object stub of the GX2 backend.
-
class Gx2ShaderProgram Shader program of the GX2 backend (aliased as
RHI::ShaderProgram).- struct BlockBinding An explicit uniform block of a stage and the engine binding point that feeds it.
- struct FetchShaderEntry A built fetch shader together with the vertex format fingerprint it was built for.
- struct LooseUniform One loose uniform of a stage, copied into the stage's loose-uniform block per draw.
- struct SamplerBinding A pixel-stage sampler: the unit the shader samples and the unit the pipeline binds to.
- struct StageBindings What the device uploads for one stage before a draw.
- class Gx2ShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class Gx2ShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). - class Gx2Texture Texture object of the GX2 backend (aliased as
RHI::Texture). - class Gx2Uniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class Gx2UniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class Gx2UniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class Gx2UniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - class Gx2VertexArray Vertex array object stub of the GX2 backend (aliased as
RHI::VertexArray). -
class Gx2VertexFormat Vertex layout description of the GX2 backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
-
namespace Gx2Memory GPU-visible memory of the GX2 backend.
-
namespace GXM PlayStation Vita backend driving
sceGxmnatively, selected byWITH_RHI_GXM.-
namespace GxmMemory GPU-visible memory of the sceGxm backend.
- struct Block A GPU-visible allocation: the kernel block that owns it and its CPU-side base address.
- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- class GxmAttribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class GxmBufferObject Buffer object of the sceGxm backend (aliased as
RHI::Buffer). -
class GxmDebug Debug-output and object-labelling facade of the sceGxm backend.
- class ScopedGroup RAII scope for a debug message group (a
sceGxmPushUserMarker()/sceGxmPopUserMarker()pair).
- class ScopedGroup RAII scope for a debug message group (a
-
class GxmDevice Pipeline-state and draw-call facade of the sceGxm backend (aliased as
RHI::Device).- struct BlendingState
- struct CullFaceState
- struct DepthTestState
- struct DisplayQueueCallbackData What the display-queue callback needs to hand one finished buffer to the display controller.
- struct PendingScene A scene that has been submitted but is not known to be finished yet.
- struct ScissorState
- struct UniformRange
- class GxmFramebuffer Framebuffer stub of the sceGxm backend (aliased as
RHI::Framebuffer). - class GxmRenderbuffer Renderbuffer stub of the sceGxm backend (aliased as
RHI::Renderbuffer). - class GxmRenderTarget Off-screen render target of the sceGxm backend (aliased as
RHI::RenderTarget). - class GxmRhiCapabilities Runtime capabilities of the GXM backend.
- class GxmShader Shader-object stub of the sceGxm backend.
-
class GxmShaderCache On-disk cache of the GXP binaries SceShaccCg produced for the PS Vita's Cg stage sources.
- struct Entry
-
class GxmShaderProgram Shader program of the sceGxm backend (aliased as
RHI::ShaderProgram).- struct CachedFragmentProgram
- struct CachedVertexProgram
- struct GxmBlockUpload Where one uniform block's bytes go in a stage's default uniform buffer.
- struct GxmSamplerSlot Where one of a stage's samplers takes its texture from.
- struct ResolvedUniform
- class GxmShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class GxmShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). - struct GxmStageAttribute One vertex attribute the compiled stage declares, as the shader itself reports it.
- class GxmTexture Texture object of the sceGxm backend (aliased as
RHI::Texture). - class GxmUniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class GxmUniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class GxmUniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class GxmUniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - struct GxmUniformSlot One reflected sceGxm program parameter the draw path writes a uniform into.
- class GxmVertexArray Vertex array object stub of the sceGxm backend (aliased as
RHI::VertexArray). -
class GxmVertexFormat Vertex layout description of the sceGxm backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
-
namespace GxmMemory GPU-visible memory of the sceGxm backend.
-
namespace LegacyGL Fixed-function OpenGL 1.x backend, selected by
WITH_RHI_LEGACYGL.- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- class LegacyGlAttribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class LegacyGlBuffer Host-memory buffer object of the legacy GL backend (aliased as
RHI::Buffer). -
class LegacyGlDebug Debug-output and object-labelling stub of the legacy GL backend.
- class ScopedGroup RAII scope for a debug message group (a no-op for the legacy GL backend).
-
class LegacyGlDevice Pipeline-state and draw-call facade of the legacy-OpenGL backend (aliased as
RHI::Device).- struct BlendingState
- struct CullFaceState
- struct DepthTestState
- struct PendingSoftwareLight
- struct ScissorState
- struct UniformRange
- class LegacyGlFramebuffer Framebuffer stub of the legacy GL backend (aliased as
RHI::Framebuffer). - class LegacyGlRenderbuffer Renderbuffer stub of the legacy GL backend (aliased as
RHI::Renderbuffer). - class LegacyGlRenderTarget Off-screen render target of the legacy GL backend (aliased as
RHI::RenderTarget). - class LegacyGlRhiCapabilities Runtime capabilities of the legacy OpenGL backend.
- class LegacyGlShader Shader-object stub of the legacy GL backend.
-
class LegacyGlShaderProgram Shader program of the legacy GL backend (aliased as
RHI::ShaderProgram).- struct DispatchFacts Facts of the program the draw dispatch reads on every command, resolved once at introspection.
- struct ResolvedUniform
- class LegacyGlShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class LegacyGlShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). -
class LegacyGlTexture Texture object of the legacy GL backend (aliased as
RHI::Texture).- struct BakedStore
- struct Page One GL-addressable piece of the texture.
- class LegacyGlUniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class LegacyGlUniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class LegacyGlUniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class LegacyGlUniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - class LegacyGlVertexArray Vertex array object stub of the legacy GL backend (aliased as
RHI::VertexArray). -
class LegacyGlVertexFormat Vertex layout description of the legacy GL backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
-
namespace Metal Metal backend for macOS and iOS, selected by
WITH_RHI_METAL.- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- class MetalAttribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class MetalBufferObject Buffer object of the Metal backend (aliased as
RHI::Buffer). -
class MetalDebug Debug-output and object-labelling stub of the Metal backend.
- class ScopedGroup RAII scope for a debug message group (a no-op for the Metal backend).
-
class MetalDevice Pipeline-state and draw-call facade of the Metal backend (aliased as
RHI::Device).- struct BlendingState
- struct CullFaceState
- struct DepthTestState
- struct ScissorState
- struct UniformRange
- class MetalFramebuffer Framebuffer stub of the Metal backend (aliased as
RHI::Framebuffer). - class MetalRenderbuffer Renderbuffer stub of the Metal backend (aliased as
RHI::Renderbuffer). - class MetalRenderTarget Off-screen render target of the Metal backend (aliased as
RHI::RenderTarget). - class MetalRhiCapabilities Runtime capabilities of the Metal backend.
- class MetalShader Shader-object stub of the Metal backend.
-
class MetalShaderProgram Shader program of the Metal backend (aliased as
RHI::ShaderProgram).- struct DescriptorBinding One entry of the program's argument table, matching the offline emitter's binding scheme.
- struct LooseUniform A loose (default-block) uniform gathered into the "_Globals" buffer, with its std140 placement.
- struct ResolvedUniform
- struct VertexAttrib A vertex attribute for building the pipeline's vertex descriptor.
- class MetalShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class MetalShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). - class MetalTexture Texture object of the Metal backend (aliased as
RHI::Texture). - class MetalUniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class MetalUniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class MetalUniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class MetalUniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - class MetalVertexArray Vertex array object stub of the Metal backend (aliased as
RHI::VertexArray). -
class MetalVertexFormat Vertex layout description of the Metal backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
-
namespace PICA Nintendo 3DS fixed-function PICA200 backend on top of citro3d, selected by
WITH_RHI_PICA.- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- class PicaAttribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class PicaBuffer Host-memory buffer object of the PICA backend (aliased as
RHI::Buffer). -
class PicaDebug Debug-output and object-labelling stub of the PICA backend.
- class ScopedGroup RAII scope for a debug message group (a no-op for the PICA backend).
-
class PicaDevice Pipeline-state and draw-call facade of the PICA backend (aliased as
RHI::Device).- struct BlendingState
- struct CullFaceState
- struct DepthTestState
- struct PendingSoftwareLight
- struct ScissorState
- struct UniformRange
- class PicaFramebuffer Framebuffer stub of the PICA backend (aliased as
RHI::Framebuffer). - class PicaRenderbuffer Renderbuffer stub of the PICA backend (aliased as
RHI::Renderbuffer). - class PicaRenderTarget Off-screen render target of the PICA backend (aliased as
RHI::RenderTarget). - class PicaRhiCapabilities Runtime capabilities of the PICA backend.
- class PicaShader Shader-object stub of the PICA backend.
-
class PicaShaderProgram Shader program of the PICA backend (aliased as
RHI::ShaderProgram).- struct DispatchFacts Facts of the program the draw dispatch reads on every command, resolved once at introspection.
- struct ResolvedUniform
- class PicaShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class PicaShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). -
class PicaTexture Texture object of the PICA backend (aliased as
RHI::Texture).- struct BakedStore
- struct Page One GPU-addressable piece of the texture.
- class PicaUniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class PicaUniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class PicaUniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class PicaUniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - class PicaVertexArray Vertex array object stub of the PICA backend (aliased as
RHI::VertexArray). -
class PicaVertexFormat Vertex layout description of the PICA backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
-
namespace PVR Sega Dreamcast fixed-function PowerVR backend on top of KallistiOS, selected by
WITH_RHI_PVR.- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- class PvrAttribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class PvrBuffer Host-memory buffer object of the PVR backend (aliased as
RHI::Buffer). -
class PvrDebug Debug-output and object-labelling stub of the PVR backend.
- class ScopedGroup RAII scope for a debug message group (a no-op for the PVR backend).
-
class PvrDevice Pipeline-state and draw-call facade of the PVR backend (aliased as
RHI::Device).- struct BlendingState
- struct CullFaceState
- struct DepthTestState
- struct PaletteBank
- struct PendingSoftwareLight
- struct ScissorState
- struct UniformRange
- class PvrFramebuffer Framebuffer stub of the PVR backend (aliased as
RHI::Framebuffer). - class PvrRenderbuffer Renderbuffer stub of the PVR backend (aliased as
RHI::Renderbuffer). - class PvrRenderTarget Off-screen render target of the PVR backend (aliased as
RHI::RenderTarget). - class PvrRhiCapabilities Runtime capabilities of the PowerVR backend.
- class PvrShader Shader-object stub of the PVR backend.
-
class PvrShaderProgram Shader program of the PVR backend (aliased as
RHI::ShaderProgram).- struct DispatchFacts Facts of the program the draw dispatch reads on every command, resolved once at introspection.
- struct ResolvedUniform
- class PvrShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class PvrShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). -
class PvrTexture Texture object of the PVR backend (aliased as
RHI::Texture).- struct BakedSlot
- class PvrUniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class PvrUniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class PvrUniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class PvrUniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - class PvrVertexArray Vertex array object stub of the PVR backend (aliased as
RHI::VertexArray). -
class PvrVertexFormat Vertex layout description of the PVR backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
- struct TileRecord One tile of a tile-layer mesh in the packed form the PVR dispatch reads.
-
namespace RDP Nintendo 64 fixed-function Reality Display Processor backend, selected by
WITH_RHI_RDP.- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- struct QuadRecord One quad of any size, with its own colour and optionally turned, in the packed form the RDP dispatch reads.
- class RdpAttribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class RdpBuffer Host-memory buffer object of the RDP backend (aliased as
RHI::Buffer). -
class RdpDebug Debug-output and object-labelling stub of the RDP backend.
- class ScopedGroup RAII scope for a debug message group (a no-op for the RDP backend).
-
class RdpDevice Pipeline-state and draw-call facade of the RDP backend (aliased as
RHI::Device).- struct BlendingState
- struct CullFaceState
- struct DepthTestState
- struct PendingSoftwareLight
- struct ScissorState
- struct UniformRange
- class RdpFramebuffer Framebuffer stub of the RDP backend (aliased as
RHI::Framebuffer). - class RdpRenderbuffer Renderbuffer stub of the RDP backend (aliased as
RHI::Renderbuffer). - class RdpRenderTarget Off-screen render target of the RDP backend (aliased as
RHI::RenderTarget). - class RdpRhiCapabilities Runtime capabilities of the RDP backend.
- class RdpShader Shader-object stub of the RDP backend.
-
class RdpShaderProgram Shader program of the RDP backend (aliased as
RHI::ShaderProgram).- struct DispatchFacts Facts of the program the draw dispatch reads on every command, resolved once at introspection.
- struct ResolvedUniform
- class RdpShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class RdpShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). -
class RdpTexture Texture object of the RDP backend (aliased as
RHI::Texture).- struct BakedStore
- class RdpUniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class RdpUniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class RdpUniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class RdpUniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - class RdpVertexArray Vertex array object stub of the RDP backend (aliased as
RHI::VertexArray). -
class RdpVertexFormat Vertex layout description of the RDP backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
- struct TileRecord One tile of a tile-layer mesh in the packed form the RDP dispatch reads.
-
namespace RSX PlayStation 3 backend driving the RSX through libgcm natively, selected by
WITH_RHI_RSX.-
namespace RsxVram Suballocator for the two address windows the RSX reads — local GDDR3 and mapped main memory.
- struct Block A GPU-visible allocation: its CPU-side base address and the offset the RSX addresses it by.
- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- class RsxAttribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class RsxBufferObject Buffer object of the RSX backend (aliased as
RHI::Buffer). -
class RsxDebug Debug-output and object-labelling facade of the RSX backend.
- class ScopedGroup RAII scope for a debug message group (inert on this backend).
-
class RsxDevice Pipeline-state and draw-call facade of the RSX backend (aliased as
RHI::Device).- struct BlendingState
- struct CullFaceState
- struct DepthTestState
- struct RetiredBlock A retired block together with the frame it stopped being referenced in.
- struct ScissorState
- struct UniformRange
- class RsxFramebuffer Framebuffer stub of the RSX backend (aliased as
RHI::Framebuffer). - class RsxRenderbuffer Renderbuffer stub of the RSX backend (aliased as
RHI::Renderbuffer). - class RsxRenderTarget Off-screen render target of the RSX backend (aliased as
RHI::RenderTarget). - class RsxRhiCapabilities Runtime capabilities of the RSX backend.
- class RsxShader Shader-object stub of the RSX backend.
-
class RsxShaderProgram Shader program of the RSX backend (aliased as
RHI::ShaderProgram).- struct RsxBlockUpload Where one uniform block's bytes go among a stage's constants.
- struct RsxInstanceArray The batched instance array of a stage, if it has one.
- struct RsxInstanceField One field of a batched instance element, and where it sits on each side.
- struct RsxSamplerBinding Where one of a stage's samplers takes its texture from.
- class RsxShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class RsxShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). - struct RsxStageAttribute One vertex attribute the compiled stage declares, as the shader itself reports it.
- class RsxTexture Texture object of the RSX backend (aliased as
RHI::Texture). - class RsxUniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class RsxUniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class RsxUniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class RsxUniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - struct RsxUniformSlot One reflected RSX program constant the draw path writes a uniform into.
- class RsxVertexArray Vertex array object stub of the RSX backend (aliased as
RHI::VertexArray). -
class RsxVertexFormat Vertex layout description of the RSX backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
-
namespace RsxVram Suballocator for the two address windows the RSX reads — local GDDR3 and mapped main memory.
-
namespace Software CPU software rasterizer backend, selected by
WITH_RHI_SOFTWARE.-
namespace sw Runtime support types for the transpiled (GLSL→C++) software shaders.
- namespace detail Implementation details of the software shader runtime.
- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- struct Framebuffer Destination framebuffer the device presents and resolves draws into.
- class SwAttribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class SwBuffer Host-memory buffer object of the software backend (aliased as
RHI::Buffer). -
class SwDebug Debug-output and object-labelling stub of the software backend.
- class ScopedGroup RAII scope for a debug message group (a no-op for the software backend).
-
class SwDevice Pipeline-state and draw-call facade of the software backend (aliased as
RHI::Device).- struct BlendingState
- struct CullFaceState
- struct DepthTestState
- struct PendingSoftwareLight One queued software-lighting/water combine, submitted by the compositor and applied at the next Combine draw.
- struct ScissorState
- struct UniformRange
- class SwFramebuffer Framebuffer stub of the software backend (aliased as
RHI::Framebuffer). - class SwRenderbuffer Renderbuffer stub of the software backend (aliased as
RHI::Renderbuffer). - class SwRenderTarget Off-screen render target of the software backend (aliased as
RHI::RenderTarget). - class SwRhiCapabilities Runtime capabilities of the software rasterizer backend.
- class SwShader Shader-object stub of the software backend.
-
class SwShaderProgram Shader program of the software backend (aliased as
RHI::ShaderProgram).- struct DispatchFacts Facts of the program the draw dispatch reads on every command, resolved once at introspection.
- struct ResolvedUniform
- class SwShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class SwShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). - class SwTexture CPU texture object of the software backend (aliased as
RHI::Texture). - class SwUniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class SwUniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class SwUniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class SwUniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - class SwVertexArray Vertex array object stub of the software backend (aliased as
RHI::VertexArray). -
class SwVertexFormat Vertex layout description of the software backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
-
namespace sw Runtime support types for the transpiled (GLSL→C++) software shaders.
-
namespace Vulkan Vulkan backend, selected by
WITH_RHI_VULKAN.- namespace UniformTypeInfo Free-function helpers that classify reflected uniform types (component count, float-ness).
- class VulkanAttribute Reflected metadata of a single active vertex attribute (aliased as
RHI::Attribute). - class VulkanBufferObject Buffer object of the Vulkan backend (aliased as
RHI::Buffer). -
class VulkanDebug Debug-output and object-labelling stub of the Vulkan backend.
- class ScopedGroup RAII scope for a debug message group (a no-op for the Vulkan backend).
-
class VulkanDevice Pipeline-state and draw-call facade of the Vulkan backend (aliased as
RHI::Device).- struct BlendingState
- struct CullFaceState
- struct DepthTestState
- struct ScissorState
- struct UniformRange
- class VulkanFramebuffer Framebuffer stub of the Vulkan backend (aliased as
RHI::Framebuffer). - class VulkanRenderbuffer Renderbuffer stub of the Vulkan backend (aliased as
RHI::Renderbuffer). - class VulkanRenderTarget Off-screen render target of the Vulkan backend (aliased as
RHI::RenderTarget). - class VulkanRhiCapabilities Runtime capabilities of the Vulkan backend.
- class VulkanShader Shader-object stub of the Vulkan backend.
-
class VulkanShaderProgram Shader program of the Vulkan backend (aliased as
RHI::ShaderProgram).- struct DescriptorBinding One entry of the descriptor set (set 0), matching the offline emitter's binding scheme.
- struct LooseUniform A loose (default-block) uniform gathered into the "_Globals" UBO, with its std140 placement.
- struct ResolvedUniform
- struct VertexAttrib A vertex attribute for building the pipeline's vertex input state.
- class VulkanShaderUniformBlocks Manages the uniform-block caches of a program (aliased as
RHI::ShaderUniformBlocks). - class VulkanShaderUniforms Manages the loose-uniform caches of a program (aliased as
RHI::ShaderUniforms). - class VulkanTexture Texture object of the Vulkan backend (aliased as
RHI::Texture). - class VulkanUniform Reflected metadata of a single active uniform (aliased as
RHI::Uniform). - class VulkanUniformBlock Reflected metadata of a single active uniform block (aliased as
RHI::UniformBlock). -
class VulkanUniformBlockCache Caches the contents of a uniform block (aliased as
RHI::UniformBlockCache).- struct NamedCache
- class VulkanUniformCache Caches the host-side value of a single uniform (aliased as
RHI::UniformCache). - class VulkanVertexArray Vertex array object stub of the Vulkan backend (aliased as
RHI::VertexArray). -
class VulkanVertexFormat Vertex layout description of the Vulkan backend (aliased as
RHI::VertexFormat).- class Attribute A single vertex attribute within a vertex format.
- struct AuxiliarySwapchainDesc What
Device::CreateAuxiliarySwapchain()needs of a window besides the main one. - struct BufferRange Locates a sub-range within a buffer object, together with its mapped memory.
- struct FixedFunctionPass One pass of a fixed-function effect, as described by a shader's
fixed_functionblock. -
class IRhiCapabilities Interface to query the runtime capabilities of the selected RHI backend.
- struct InfoStrings Device information strings.
- class RhiCapabilitiesBase Backend-independent part of the RHI capabilities.
-
namespace D3D11 Direct3D 11 backend, selected by
- class AccelerometerEvent Accelerometer sensor reading.
- class AicaAudioDevice Dreamcast implementation of IAudioDevice on top of the AICA.
- class ALAudioDevice OpenAL implementation of IAudioDevice.
- class AmigaAudioDevice Classic Amiga implementation of IAudioDevice on top of ahi.device.
-
class AndroidApplication Main entry point and handler for Android applications.
- struct DeferredInputEvent Input event received from the Java UI thread and waiting to be dispatched on the main thread.
- 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 AsndAudioDevice Wii/GameCube implementation of IAudioDevice on top of libogc's ASND.
- class AudioBuffer Fully decoded audio buffer.
- class AudioBufferPlayer Plays back a fully decoded AudioBuffer.
- class AudioDeviceBase Backend-independent part of an audio device.
- class AudioLoaderMp3 Audio loader for the MPEG audio format (MP3), backed by
libmpg123. - 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 AudioLoaderXmp Audio loader for tracker module formats, backed by
libxmp(see AudioReaderXmp). - struct AudioModuleState Position and timing of a tracker module, see IAudioReader::
GetModuleStateAt(). - class AudioReaderMp3 Audio reader for the MPEG audio format (MP3), backed by
libmpg123. -
class AudioReaderMpt Audio reader for tracker module formats, backed by
libopenmpt.- struct ChannelSlide
- struct TimelineEntry
- class AudioReaderOgg Audio reader for the Ogg Vorbis format, backed by
libvorbis. - class AudioReaderWav Audio reader for the WAVE (
.wav) format. - class AudioReaderXmp Audio reader for tracker module formats, backed by
libxmp. -
class AudioStream Streams audio decoded on the fly into a rotating set of backend buffers.
- struct QueuedChunk Frames of the reader held by a queued buffer, see IAudioReader::
GetDecodedFrames().
- struct QueuedChunk Frames of the reader held by a queued buffer, see IAudioReader::
- class AudioStreamPlayer Plays back an AudioStream decoded on the fly.
- class AuxiliaryWindow Window of the application besides the main one, as a panel dragged out of it.
- struct AuxiliaryWindowDesc How a window besides the main one is made, see IGfxDevice::
CreateAuxiliaryWindow(). - class AuxiliaryWindowPresenter Shows a texture in a window besides the main one with the graphics backend, see AuxiliaryWindow.
- 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 FrameStatistics Frame timing and backend counters, averaged for an on-screen overlay.
- struct Counter Counter reported by a backend, averaged over an interval.
- struct CounterAccumulator
- struct Snapshot Values averaged over the last complete interval.
- 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.
- 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.
- struct NativeAudioInfo Properties of audio the device plays in a format of its own.
- 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 IGfxDevice Represents the interface to the graphics device where everything is rendered.
- struct ContextInfo 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 N64AudioDevice Nintendo 64 implementation of IAudioDevice on top of libdragon's RSP mixer.
- struct Buffer One buffer, playable by any number of channels at once.
- struct NativeStream Music the device plays by itself.
- struct Source One logical voice.
- class NdspAudioDevice Implementation of IAudioDevice on top of the Nintendo 3DS's NDSP.
- 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 PngCodec Reads and writes PNG images.
- struct PngDecodeOptions How PngCodec reads an image.
- struct PngImage An image as PngCodec::
Decode() reads and PngCodec:: Encode() writes it. - struct PngRgbaImage An image as PngCodec::
DecodeRgba() reads it, always RGBA, four bytes per pixel. -
class PositionAffector Affector that animates the position of a particle.
- struct PositionStep A position offset keyed to a normalized particle age.
-
class Ps2AudioDevice PlayStation 2 implementation of IAudioDevice on top of
audsrv.- struct Buffer One uploaded PCM buffer, interleaved, in main memory.
- struct IdleDecode A stream chunk being decoded in the idle time, oldest first.
- struct Source One mixer voice.
- class Ps3AudioDevice PlayStation 3 implementation of IAudioDevice on top of PSL1GHT's libaudio.
-
class PspAudioDevice Implementation of IAudioDevice on top of the PSP's
sceAudiohardware channel. - 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.
- struct DirectBatch Batched command filled with instances directly rather than collected from commands, see BeginDirectBatch().
-
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.
-
class RenderCommand Holds all the state needed to issue a single draw call.
- struct InstanceUniforms The instance block members a sprite-like material rewrites for every quad it draws.
- 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.
- struct Part Commands of a range of layers, a part of a queue drawn in parts (see NextPart()).
-
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 SdlAudioDevice Implementation of IAudioDevice on top of SDL2's audio queue.
- 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 StreamDecodeRequest Request to decode one buffer of audio stream data, usually on the decoding thread.
-
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 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.
- 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 ShaderCompiler Offline shader preprocessing tool, see Shader compilation.
- namespace VertexIdRewrite
- struct Attribute
- struct AttributeDecl
- struct AttributeInfo Vertex attribute ("in" declaration in the vertex stage).
- struct BackendArtifacts The stage artifacts only a platform-specific compiler can produce.
- struct BlockDecl
- struct BlockInfo std140 uniform block
- struct BlockMember
- class ConsoleFixedFunction Transpiles
fixed_functionblocks into C++ effect functions over the EffectContext contract. - class ConstFolder Computes literal constant-folding rewrites for one fold unit.
- struct Diagnostic Error description pointing into the input file.
- class Emitter Emits the generated C++ header and the "--check" reflection dump.
- class Essl100Emitter Transforms an already-lowered modern-GLSL stage source into ESSL 100 (OpenGL ES 2.0).
- struct Expr One expression-tree node; the type-free shape shared by the AST-based lowerings.
- struct Field
- struct FixedFunctionBlock One captured "void fixed_function([<target>[, <target>...]]) { ... }" block.
- struct FixedFunctionResult Outcome of transpiling one fixed_function block variant to C++.
- struct FoldEdit One computed rewrite: columns [Begin, End) of line Index collapse to Replacement.
- struct FoldInputLine One input line range of a fold unit (positions must be valid in the rewritable original text).
- struct Function
- struct GlobalVarDecl
- class GlslExprTokenizer GLSL expression tokenizer (reusable outside the folder).
- struct GlslInstanceMember One scalar/vector member of the per-instance std140 block, with its baked byte offset.
- class GlslReflector Parses global-scope GLSL declarations and computes std140 layouts.
- class GlslToCpp Transpiles lowered fragment GLSL into a C++ software-renderer fragment function.
- struct GlslToCppResult Outcome of transpiling one fragment shader to C++.
- struct GlslToken One GLSL expression token with its position in the source line it came from.
- class HlslEmitter Transforms an already-lowered modern-GLSL stage source into HLSL (Shader Model 4/5).
- struct MemberInfo Member of a struct or std140 uniform block.
- class MslEmitter Transforms an already-lowered modern-GLSL stage source into Metal Shading Language.
- struct Param
-
class Parser Grows the shared typed AST (declarations + per-function statement trees) from an already-lowered modern-GLSL stage token stream.
- struct FragOutputDecl
-
class Preprocessor Object-like macro preprocessor used to produce the per-variant declaration stream for reflection.
- struct Macro
- struct Program
- struct ProgramReflection One lowered program (document plus per-variant reflection) to be emitted into a generated header.
- struct ProgramVariant
- class RuntimeProgram A ".shader" program compiled at runtime, owning its sources and reflection.
- struct RuntimeVariant One variant of a runtime-compiled program: lowered stage sources plus merged reflection.
- struct SamplerBinding A sampler uniform's texture-unit assignment, taken from the program's reflection.
- struct SamplerDecl
- struct ShaderDocument Lowered ".shader" document — directives plus raw (unpreprocessed) per-stage GLSL line streams.
- class ShaderParser Parses and lowers the ".shader" input language.
- struct SourceLine One line of source text together with its 1-based line number in the original ".shader" file.
- struct StageReflection Reflection data collected from one stage (or merged for a whole program).
- struct Stmt
- struct StructDecl
- struct StructInfo User struct declaration with its computed std140 layout.
- struct TextureBinding
- struct TextureDirective Texture unit assignment for a sampler uniform — from a "texture_unit(N)" uniform hint or the implicit canvas TEXTURE registration.
- struct TextureInfo Sampler uniform with its optional "texture_unit(N)" hint unit assignment.
- struct TyRef A type plus, for Ty::Struct, the user struct name (so struct-typed members resolve their fields).
- struct Uniform
- struct UniformBlock
- struct UniformDecl
- struct UniformInfo Loose (non-block, non-sampler) uniform.
- struct VariantDirective Named variant from a "variant" directive.
- struct VariantReflection Reflection of one program variant (the unnamed base or a named variant), merged across stages.
- struct VaryingDecl
- class VulkanGlslEmitter Transforms an already-lowered modern-GLSL stage source into Vulkan-flavored GLSL ("#version 450").