Cheryl Engine

API Reference

  • C++ API
    • Symbols
      • Namespace CE
      • Namespace CE::Application
      • Namespace CE::Application::DebugTerminal
      • Namespace CE::Application::GLFWOpenGL
      • Namespace CE::Assets
      • Namespace CE::Assets::Animation
      • Namespace CE::Assets::Cache
      • Namespace CE::Assets::Cache::Detail
      • Namespace CE::Assets::Graphics
      • Namespace CE::Assets::Grids
      • Namespace CE::Assets::Images
      • Namespace CE::Assets::Loading
      • Namespace CE::Assets::Manifests
      • Namespace CE::Assets::Materials
      • Namespace CE::Assets::Shaders
      • Namespace CE::Assets::Sprites
      • Namespace CE::Assets::Tilesets
      • Namespace CE::Assets::Tilesets::Selection
      • Namespace CE::Audio
      • Namespace CE::Audio::Miniaudio
      • Namespace CE::Diagnostics
      • Namespace CE::Events
      • Namespace CE::Exceptions
      • Namespace CE::Files
      • Namespace CE::Game
      • Namespace CE::Input
      • Namespace CE::Input::Actions
      • Namespace CE::Input::Actions::Detail
      • Namespace CE::Input::Capture
      • Namespace CE::Input::Events
      • Namespace CE::Input::MouseControl
      • Namespace CE::Input::Routing
      • Namespace CE::Logging
      • Namespace CE::Logging::Categories
      • Namespace CE::Logging::Compile
      • Namespace CE::Math
      • Namespace CE::Memory
      • Namespace CE::Memory::Allocators
      • Namespace CE::Memory::Objects
      • Namespace CE::Memory::Ordering
      • Namespace CE::Memory::Pointers
      • Namespace CE::Platform
      • Namespace CE::Platform::GLFW
      • Namespace CE::Rendering
      • Namespace CE::Rendering::Detail
      • Namespace CE::Rendering::Geometry
      • Namespace CE::Rendering::Materials
      • Namespace CE::Rendering::OpenGL
      • Namespace CE::Rendering::OpenGL::TextureFormat
      • Namespace CE::Rendering::OpenGL::TextureWrap
      • Namespace CE::Rendering::Parameters
      • Namespace CE::Rendering::Pipelines
      • Namespace CE::Rendering::Resources
      • Namespace CE::Rendering::Sampling
      • Namespace CE::Rendering::Submission
      • Namespace CE::Runtime
      • Namespace CE::Runtime::Simulation
      • Namespace CE::State
      • Namespace CE::Text
      • Namespace CE::Text::Legacy
      • Namespace CE::Text::Numbers
      • Namespace CE::Text::Rendering
      • Namespace CE::Time
      • Namespace CE::UI
      • Namespace CE::UI::RmlUi
      • Namespace CE::UI::TGUI
      • Namespace CE::Workers
      • Namespace CE::Workers::Hwloc
      • Namespace CE::Workers::Json
      • Namespace Rml
      • Namespace std
      • Namespace tgui
      • Struct ApplicationOptions
      • Struct Options
      • Struct RuntimeOptions
      • Struct StartupBackend
      • Struct StartupOptions
      • Struct StartupResult
      • Template Struct Cursor
      • Struct TimedFrame
      • Template Struct AssetCatalogueChanged
      • Struct CatalogueGeneration
      • Template Struct CatalogueObservation
      • Template Struct CatalogueSnapshot
      • Struct Context::PublicationContext
      • Struct Stats
      • Template Struct Store
      • Struct Store::EntrySnapshot
      • Struct Content2D
      • Struct Asset
      • Struct Definition
      • Struct GeometryData
      • Struct View
      • Struct Decoded
      • Struct Manager
      • Struct AssetUploadSettled
      • Struct ImageInput
      • Struct Loader
      • Struct Prepared
      • Struct UploadStats
      • Struct Definitions
      • Struct Graphics
      • Struct Reader
      • Struct Manager
      • Struct Asset
      • Struct Builder
      • Struct Manager
      • Struct Manifest
      • Struct Material
      • Struct MaterialRecipe
      • Struct ParameterRecipe
      • Struct Program
      • Struct ProgramCache
      • Struct ProgramRecipe
      • Struct Source
      • Struct Asset
      • Struct Clip
      • Struct Data
      • Struct Definition
      • Struct Manager
      • Struct Profile
      • Struct ProfileClip
      • Struct Animation
      • Struct Asset
      • Struct BitmaskRule
      • Struct Clip
      • Struct Data
      • Struct Definition
      • Struct Manager
      • Struct Options
      • Struct Sample
      • Struct Site
      • Struct Terrain
      • Struct Tile
      • Struct WangRule
      • Struct WangSignatureHash
      • Struct WangTile
      • Struct Format
      • Struct DecodeOptions
      • Struct PlaybackEnded
      • Struct PlaybackNotificationOptions
      • Struct PlaybackNotifications
      • Struct PlaybackOptions
      • Struct PlaybackTerminal
      • Struct VoiceSnapshot
      • Struct DispatchStats
      • Struct EventStats
      • Struct EventSystem
      • Struct AbstractGame
      • Struct TickContext
      • Struct AxisOptions
      • Struct AxisPollState
      • Struct AxisTickState
      • Struct ButtonPollState
      • Struct ButtonTickState
      • Struct Chord
      • Struct ContextAxis
      • Struct ContextButton
      • Struct ContextDefinition
      • Struct Id
      • Struct Control
      • Struct Axis
      • Struct Button
      • Struct Pointer
      • Struct Record
      • Struct Scroll
      • Struct Text
      • Struct GamepadAvailability
      • Struct GamepadAvailabilityChanged
      • Struct PollingOptions
      • Struct PollSnapshot
      • Struct Focus
      • Struct BackendStats
      • Struct Config
      • Struct FileEventHandlers
      • Struct QueueStats
      • Template Struct AbstractBlockManager
      • Template Struct DefaultAllocator
      • Template Struct ObjectAllocator
      • Template Struct ObjectPoolAllocator
      • Template Struct Block
      • Template Struct BlockManagement
      • Struct BlockManagement::State
      • Template Struct BlockManagerInterface
      • Template Struct BlockTransactions
      • Struct ByteReleaseContext
      • Template Struct Manager
      • Template Struct Constructor
      • Template Struct Factory
      • Template Struct Pool
      • Template Struct PoolState
      • Template Struct HeadOrder
      • Template Struct PoolOrder
      • Template Struct RegistryOrder
      • Struct Stats
      • Template Struct Dimensions
      • Struct FramebufferSize
      • Struct DeviceSnapshot
      • Struct OpenGLContextOptions
      • Struct Resolution
      • Struct Monitor
      • Struct WindowCloseRequested
      • Struct WindowResized
      • Struct ClipRect2D
      • Struct ClipRegion2D
      • Struct DrawPacket2D
      • Struct DrawStyle2D
      • Struct Anchor
      • Struct Buffer2D
      • Struct Pivot
      • Struct PixelPoint
      • Struct PixelRect
      • Struct PixelSize
      • Struct Quad
      • Struct QuadTriangleStrip
      • Struct Triangle
      • Template Struct TriangleStrip
      • Struct Vertex2D
      • Struct Vertex2DColor
      • Struct Vertex3D
      • Struct GraphicsDomainSnapshot
      • Struct GraphicsDomainStateChanged
      • Struct Definition
      • Struct MaterialBindings
      • Struct ParameterBinding
      • Struct PipelineBindings
      • Struct Program
      • Struct ResourceStats
      • Struct Texture
      • Struct Variable
      • Struct VertexArray
      • Struct Definition
      • Struct DrawSemantics
      • Struct ImageBinding
      • Struct PassSemantics
      • Struct Pass
      • Struct Definition
      • Struct PassConstraints2D
      • Struct State2D
      • Struct PixelClipRect2D
      • Struct Image
      • Struct Program
      • Struct Provider
      • Struct Options
      • Struct Context2D
      • Struct ImageParameter2D
      • Struct ExecutionOptions
      • Struct InitializedCapabilities
      • Struct PlatformMaintenance
      • Struct RuntimeFailure
      • Struct RuntimeLifecycleSnapshot
      • Struct RuntimeQuiescing
      • Struct RuntimeReady
      • Struct RuntimeStats
      • Struct RuntimeStopped
      • Struct ShutdownPolicyOptions
      • Struct ShutdownRequest
      • Struct ShutdownRequestCancelled
      • Struct ShutdownRequested
      • Struct ShutdownResult
      • Struct ShutdownSnapshot
      • Struct ShutdownStarting
      • Struct ShutdownTicket
      • Struct Batch
      • Struct Step
      • Struct TimingOptions
      • Struct SimulationStepStarting
      • Struct SimulationView
      • Struct SimulationViewChanged
      • Struct WindowState
      • Struct WindowStateChanged
      • Template Struct VersionedSnapshot
      • Struct FontConfiguration
      • Struct FontFace
      • Struct FontFaceInfo
      • Struct FontFamily
      • Struct FontFile
      • Struct FontRasterGlyph
      • Struct FontRasterMetrics
      • Struct FontRasterOptions
      • Struct FontRasterProperties
      • Struct FontRasterSize
      • Struct FontSelection
      • Struct FontStyle
      • Struct FontVariation
      • Struct GlyphId
      • Struct LayoutOptions
      • Struct AsciiFont
      • Struct AsciiFontData
      • Struct BitmapFont
      • Struct Font
      • Struct GlyphPlacement
      • Struct LayoutOptions
      • Struct Manager
      • Struct DrawRun
      • Struct Failure
      • Struct GlyphDraw
      • Struct PageResources
      • Struct PreparedPage
      • Struct RasterOptions
      • Struct Request
      • Struct ShapedGlyph
      • Struct SourceRange
      • Struct SystemFontFamily
      • Struct TextLine
      • Struct Utf8Scalar
      • Template Struct is_chrono_duration
      • Template Struct is_chrono_duration< std::chrono::duration< Rep, Period > >
      • Struct Capabilities
      • Struct Materials
      • Struct RecordedDraw
      • Struct SessionOptions
      • Struct Capabilities
      • Struct Materials
      • Struct Offset
      • Struct RecordedDraw
      • Struct Scalable
      • Struct SessionOptions
      • Struct WidgetLayout
      • Struct CacheDomain
      • Struct Capabilities
      • Struct Configuration
      • Struct Core
      • Struct CpuPolicy
      • Struct GroupOptions
      • Struct GroupPolicy
      • Struct GroupStatus
      • Struct PoolOptions
      • Struct Topology
      • Template Struct allocator_traits< ::CE::Memory::Allocators::DefaultAllocator< T > >
      • Template Struct allocator_traits< ::CE::Memory::Allocators::ObjectAllocator< T > >
      • Template Struct allocator_traits< ::CE::Memory::Allocators::ObjectPoolAllocator< T > >
      • Template Struct formatter< ::CE::Memory::Block< T > >
      • Template Struct hash< CE::Input::Actions::Id >
      • Template Struct hash< CE::Input::Control >
      • Template Struct hash< ::CE::Memory::Block< T > >
      • Class Startup
      • Template Class AssetCatalogue
      • Class AssetCatalogue::Watch
      • Class Context
      • Class FileRegistry
      • Class Animation
      • Class Clip
      • Class System
      • Class System
      • Class Voice
      • Class EventBus
      • Class EventBus::Publisher
      • Class EventBus::Registration
      • Template Class EventChannel
      • Class bad_alloc
      • Class bad_request
      • Class exception_base
      • Class failed_operation
      • Class invalid_args
      • Class runtime_exception
      • Class FileIndex
      • Class Accumulator
      • Class Bindings
      • Class Context
      • Class ContextSubmission
      • Class Snapshot
      • Class View
      • Class Collector
      • Class Lease
      • Class PollingBacklog
      • Class Lease
      • Class Manager
      • Class System
      • Class Tick
      • Template Class Log
      • Template Class Logger
      • Class LogHandle
      • Class ProcessLifetime
      • Template Class BitArray
      • Class Constructor::Context
      • Template Class Reservation
      • Class DisplaySystem
      • Class DisplaySystem
      • Class InputSystem
      • Class Window
      • Class Window
      • Class Camera2D
      • Class Camera3D
      • Class CameraBase
      • Class Frame
      • Class FrameWriter
      • Class GraphicsDomain
      • Class GraphicsDomainOwner
      • Class Context
      • Class GLFWContext
      • Class Handle
      • Class Pipeline
      • Class Renderer
      • Class ResourceLifetime
      • Class ResourceProvider
      • Class Sampler
      • Class PassWriter
      • Class PresentationSurface
      • Class Renderer
      • Class Material
      • Class Pipeline
      • Class Sampler
      • Class Context
      • Class GameRuntime
      • Class PlatformDispatcher
      • Class PlatformDispatcher::Submission
      • Class RuntimeLifecycle
      • Class RuntimeServices
      • Class ServiceAttachment
      • Class ShutdownDecision
      • Class ShutdownEndpoint
      • Class ShutdownPolicy
      • Class Scheduler
      • Class SimulationDispatcher
      • Class SimulationDispatcher::Submission
      • Class ViewAttachment
      • Template Class ViewSource
      • Template Class FriendSingleton
      • Template Class ObservedVariable
      • Template Class Singleton
      • Template Class StateMachine
      • Template Class StateTracker
      • Template Class VersionedVariable
      • Class Font
      • Class FontCollection
      • Class FontRasterizer
      • Class FontService
      • Class Generation
      • Class Prepared
      • Class Updater
      • Class ShapedText
      • Template Class DeltaTime
      • Class RecordedScene
      • Class RenderTarget
      • Class Scene
      • Class SceneUploader
      • Class Session
      • Class RecordedScene
      • Class Renderer
      • Class RenderTarget
      • Class Scene
      • Class SceneUploader
      • Class Session
      • Class Texture
      • Class Group
      • Class Pool
      • Class TopologyProvider
      • Enum BackendSelection
      • Enum IndexPolicy
      • Enum CatalogueChangeKind
      • Enum UploadOutcome
      • Enum Stage
      • Enum BitmaskType
      • Enum Direction
      • Enum DiagonalConnectivity
      • Enum Failure
      • Enum Fallback
      • Enum SampleState
      • Enum SiteKind
      • Enum WangType
      • Enum PlaybackEndReason
      • Enum PlaybackState
      • Enum AxisKind
      • Enum Channel
      • Enum DeviceKind
      • Enum ButtonPhase
      • Enum GamepadControl
      • Enum KeyboardKey
      • Enum Modifiers
      • Enum MouseButton
      • Enum PollingPolicy
      • Enum KeyboardPolicy
      • Enum LogLevel
      • Enum Level
      • Enum OverflowPolicy
      • Enum Profile
      • Enum FitPolicy
      • Enum WindowMode
      • Enum AnchorType
      • Enum Layout2D
      • Enum Topology
      • Enum GraphicsDomainReason
      • Enum GraphicsDomainStatus
      • Enum GraphicsMode
      • Enum Builtin2D
      • Enum ResourceKind
      • Enum Semantic
      • Enum Type
      • Enum Blend
      • Enum Cull
      • Enum Depth
      • Enum Anisotropy
      • Enum Filter
      • Enum MipmapFilter
      • Enum Wrap
      • Enum ShaderStage
      • Enum MaintenanceReason
      • Enum NativeClosePolicy
      • Enum RunMode
      • Enum RuntimeOutcome
      • Enum RuntimeStage
      • Enum ShutdownCancellation
      • Enum ShutdownCause
      • Enum ShutdownDisposition
      • Enum ShutdownReason
      • Enum ShutdownStatus
      • Enum LagRecovery
      • Enum Mode
      • Enum UpdateKind
      • Enum FontBitmapFormat
      • Enum FontSizing
      • Enum ParagraphDirection
      • Enum FailureStage
      • Enum CacheType
      • Enum LocalityPolicy
      • Enum PolicyStrength
      • Function CE::Application::DebugTerminal::run
      • Function CE::Application::GLFWOpenGL::make_context(CE::Input::System&, const Options&)
      • Function CE::Application::GLFWOpenGL::make_context(const Options&)
      • Function CE::Application::GLFWOpenGL::make_startup(CE::Input::System&, std::string, Options, CE::Application::RuntimeOptions)
      • Function CE::Application::GLFWOpenGL::make_startup(std::string, Options, CE::Application::RuntimeOptions)
      • Function CE::Application::make_startup(std::string, ApplicationOptions)
      • Function CE::Application::make_startup(CE::Input::System&, std::string, ApplicationOptions)
      • Function CE::Assets::Cache::Detail::report_catalogue_attempt
      • Function CE::Assets::Grids::make_geometry
      • Function CE::Assets::Images::decode(const std::filesystem::path&)
      • Function CE::Assets::Images::decode(std::span<const unsigned char>)
      • Function CE::Assets::Shaders::build_builtin_material
      • Function CE::Assets::Shaders::defaults
      • Function CE::Assets::Shaders::is_qualified_id
      • Function CE::Assets::Shaders::parameter_value
      • Function CE::Assets::Shaders::pipeline_definition
      • Function CE::Assets::Shaders::validate_material
      • Function CE::Assets::Shaders::validate_program
      • Function CE::Assets::Tilesets::Selection::select(const WangRule&, const Sampler&, const Options&)
      • Function CE::Assets::Tilesets::Selection::select(const BitmaskRule&, const Sampler&, const Options&)
      • Function CE::Assets::Tilesets::Selection::select(const Rule&, const Sampler&, const Options&)
      • Function CE::Audio::Miniaudio::decode_file
      • Function CE::Audio::validate_volume
      • Function CE::Diagnostics::next_domain_id
      • Function CE::Diagnostics::stack_trace
      • Function CE::Events::platform_delivery
      • Function CE::Events::simulation_delivery
      • Function CE::Events::worker_delivery
      • Function CE::Input::control_id(const KeyboardKey)
      • Function CE::Input::control_id(const MouseButton)
      • Function CE::Input::control_id(const GamepadControl)
      • Function CE::Input::has_modifier
      • Function CE::Input::operator|
      • Function CE::Logging::Compile::enabled
      • Function CE::Logging::Compile::runtime_level
      • Function CE::Logging::Compile::severity_bit
      • Template Function CE::Math::operator<<
      • Function CE::Math::overlaps
      • Function CE::Memory::adjust_length
      • Function CE::Memory::format_bytes
      • Template Function CE::Memory::is_contiguous
      • Template Function CE::Memory::make_managed_block
      • Template Function CE::Memory::operator<<(S&, const Block<T>&)
      • Template Function CE::Memory::operator<<(S&, const std::align_val_t)
      • Template Function CE::Memory::operator==
      • Template Function CE::Memory::Pointers::add_offset
      • Function CE::Memory::Pointers::align_offset
      • Function CE::Memory::Pointers::calculate_alignment(uintptr_t)
      • Function CE::Memory::Pointers::calculate_alignment(void *)
      • Function CE::Memory::Pointers::get_alignment_offset(void *, std::align_val_t)
      • Template Function CE::Memory::Pointers::get_alignment_offset(void *)
      • Function CE::Memory::Pointers::is_in_range(const uintptr_t, const uintptr_t, const uintptr_t)
      • Function CE::Memory::Pointers::is_in_range(const void *, const void *, const void *)
      • Function CE::Memory::Pointers::offset_address(const uintptr_t, const std::size_t)
      • Function CE::Memory::Pointers::offset_address(void *, const std::size_t)
      • Function CE::Memory::Pointers::pointer_to_hash
      • Function CE::Memory::reduce_fit_policy
      • Template Function CE::Memory::swap
      • Function CE::Rendering::Geometry::calculate_num_frames
      • Function CE::Rendering::Geometry::calculate_num_strip_vertices
      • Function CE::Rendering::Geometry::calculate_num_vertices
      • Function CE::Rendering::Geometry::get_anchor
      • Function CE::Rendering::Geometry::get_pivot
      • Function CE::Rendering::intersect_clip_rects
      • Function CE::Rendering::Parameters::resolve
      • Function CE::Rendering::Parameters::type_of
      • Function CE::Rendering::Parameters::validate_contract
      • Function CE::Rendering::Parameters::validate_resolved
      • Function CE::Rendering::Parameters::validate_values
      • Function CE::Rendering::Pipelines::validate
      • Function CE::Rendering::resolve_clip_region
      • Function CE::Rendering::resolve_draw_packet
      • Function CE::Rendering::Sampling::validate
      • Function CE::Rendering::shader_stage_from_extension
      • Function CE::Rendering::Submission::resolve_graphic
      • Function CE::Rendering::Submission::resolve_sprite
      • Function CE::Rendering::Submission::resolve_text(const CE::Text::Legacy::Font&, std::string_view, const DrawStyle2D&, const Context2D&, CE::Text::Legacy::LayoutOptions)
      • Function CE::Rendering::Submission::resolve_text(const CE::Text::Rendering::Generation&, const DrawStyle2D&, const Context2D&)
      • Function CE::Rendering::Submission::resolve_text_runs
      • Function CE::Rendering::Submission::resolve_tile(const CE::Assets::Tilesets::Asset&, CE::Assets::Grids::CellIndex, const DrawStyle2D&, const Context2D&)
      • Function CE::Rendering::Submission::resolve_tile(const CE::Assets::Tilesets::Tile&, const DrawStyle2D&, const Context2D&)
      • Function CE::Rendering::Submission::resolve_tile(const CE::Assets::Tilesets::Animation&, const DrawStyle2D&, const Context2D&)
      • Function CE::Rendering::validate_clip_region
      • Function CE::Rendering::validate_draw_packet
      • Function CE::Text::decode_utf8
      • Function CE::Text::decode_utf8_scalar
      • Function CE::Text::find_system_fonts()
      • Function CE::Text::find_system_fonts(const std::vector<std::filesystem::path>&)
      • Function CE::Text::layout_text(const FontCollection&, std::string_view, const LayoutOptions&)
      • Function CE::Text::layout_text(const Font&, std::string_view, const LayoutOptions&)
      • Function CE::Text::Numbers::parse_floats
      • Template Function CE::Text::Numbers::parse_integers
      • Template Function CE::Text::Numbers::string_to_number
      • Function CE::Text::Rendering::prepare
      • Function CE::Text::Rendering::upload
      • Function CE::Text::select_default_system_font
      • Function CE::Text::system_font_directories
      • Template Function CE::Time::duration_cast
      • Template Function CE::Time::to_hours
      • Template Function CE::Time::to_milliseconds
      • Template Function CE::Time::to_minutes
      • Template Function CE::Time::to_seconds
      • Function CE::UI::RmlUi::adopt_scene
      • Function CE::UI::RmlUi::keyboard_key
      • Function CE::UI::RmlUi::modifiers
      • Function CE::UI::TGUI::adopt_scene
      • Function CE::UI::TGUI::translate_event
      • Function CE::Workers::Hwloc::make_topology_provider
      • Function CE::Workers::is_group_name
      • Function CE::Workers::Json::load_configuration(std::istream&, const std::filesystem::path&)
      • Function CE::Workers::Json::load_configuration(const std::filesystem::path&)
      • Function CE::Workers::Json::parse_configuration
      • Function CE::Workers::validate_configuration
      • Function CE::Workers::validate_group_options
      • Variable CE::Assets::Cache::asset_catalogue_changed_event
      • Variable CE::Assets::Loading::asset_upload_settled_event
      • Variable CE::Audio::playback_ended_event
      • Variable CE::Input::gamepad_availability_changed_event
      • Variable CE::Input::invalid_control
      • Variable CE::Input::MouseControl::DeltaX
      • Variable CE::Input::MouseControl::DeltaY
      • Variable CE::Input::MouseControl::ScrollX
      • Variable CE::Input::MouseControl::ScrollY
      • Variable CE::Input::MouseControl::WheelDown
      • Variable CE::Input::MouseControl::WheelUp
      • Variable CE::Input::MouseControl::X
      • Variable CE::Input::MouseControl::Y
      • Variable CE::Logging::Categories::assets
      • Variable CE::Logging::Categories::cheryl
      • Variable CE::Logging::Categories::engine
      • Variable CE::Logging::Categories::memory
      • Variable CE::Logging::Categories::platform
      • Variable CE::Logging::Categories::rendering
      • Variable CE::Logging::Compile::compiled_mask
      • Variable CE::Logging::Compile::profile
      • Variable CE::Platform::window_close_requested_event
      • Variable CE::Platform::window_resized_event
      • Variable CE::Rendering::Geometry::floats_per_mesh_vertex
      • Variable CE::Rendering::Geometry::floats_per_quad
      • Variable CE::Rendering::Geometry::floats_per_quad_vertex
      • Variable CE::Rendering::Geometry::vertices_per_quad
      • Variable CE::Rendering::Geometry::vertices_per_strip_quad
      • Variable CE::Rendering::graphics_domain_state_changed_event
      • Variable CE::Rendering::OpenGL::TextureFormat::Red
      • Variable CE::Rendering::OpenGL::TextureFormat::RGBA
      • Variable CE::Rendering::OpenGL::TextureWrap::ClampToEdge
      • Variable CE::Rendering::OpenGL::TextureWrap::MirroredRepeat
      • Variable CE::Rendering::OpenGL::TextureWrap::Repeat
      • Variable CE::Runtime::platform_maintenance_event
      • Variable CE::Runtime::runtime_quiescing_event
      • Variable CE::Runtime::runtime_ready_event
      • Variable CE::Runtime::runtime_stopped_event
      • Variable CE::Runtime::shutdown_request_cancelled_event
      • Variable CE::Runtime::shutdown_requested_event
      • Variable CE::Runtime::shutdown_starting_event
      • Variable CE::Runtime::simulation_step_starting_event
      • Variable CE::Runtime::simulation_view_changed_event
      • Variable CE::Runtime::window_state_changed_event
      • Variable CE::Text::Legacy::ascii_character_count
      • Variable CE::Text::Legacy::ascii_first_character
      • Variable CE::Text::Legacy::ascii_last_character
      • Variable CE::Text::Legacy::bitmap_character_count
      • Variable CE::Time::is_chrono_duration_v
      • Define CE_API
      • Define CE_AUDIO_MINIAUDIO_API
      • Define CE_DEBUG_TERMINAL_API
      • Define CE_NATIVE_GLFW_API
      • Define CE_OPENGL_API
      • Define CE_OPENGL_STARTUP_API
      • Define CE_STARTUP_API
      • Define CE_TYPE_API
      • Define CE_UI_RMLUI_API
      • Define CE_UI_TGUI_API
      • Define CE_WORKER_TOPOLOGY_HWLOC_API
      • Define CE_WORKER_TOPOLOGY_JSON_API
      • Define CE_WORKERS_API
      • Define CHERYL_LOG_COMPILED_MASK
      • Define CHERYL_LOG_PROFILE
      • Define CTWriteMask
      • Define MDEBUG
      • Define MERROR
      • Define MFATAL
      • Define MINFO
      • Define MTRACE
      • Define MWARN
      • Typedef CE::Application::DebugTerminal::Main
      • Typedef CE::Application::DebugTerminal::Start
      • Typedef CE::Application::OptionDefinitions
      • Typedef CE::Assets::Grids::CellIndex
      • Typedef CE::Assets::Images::Store
      • Typedef CE::Assets::Shaders::Literal
      • Typedef CE::Assets::Shaders::ProgramStore
      • Typedef CE::Assets::Sprites::Store
      • Typedef CE::Assets::Tilesets::Rule
      • Typedef CE::Assets::Tilesets::Selection::Result
      • Typedef CE::Assets::Tilesets::Selection::Sampler
      • Typedef CE::Assets::Tilesets::Store
      • Typedef CE::Assets::Tilesets::WangSignature
      • Typedef CE::Diagnostics::DomainId
      • Typedef CE::Files::Extension
      • Typedef CE::Files::Path
      • Typedef CE::Input::Actions::BindingId
      • Typedef CE::Input::Actions::ContextId
      • Typedef CE::Input::ControlId
      • Typedef CE::Input::DeviceId
      • Typedef CE::Input::Events::Payload
      • Typedef CE::Input::ObservationClock
      • Typedef CE::Input::ObservationDuration
      • Typedef CE::Input::Routing::TargetId
      • Typedef CE::Memory::ByteBlock
      • Typedef CE::Memory::CachedManager
      • Typedef CE::Memory::ExactManager
      • Typedef CE::Memory::HeapBlock
      • Typedef CE::Memory::ObjectMemoryManager
      • Typedef CE::Memory::OptionalBlock
      • Typedef CE::Memory::OptionalByteBlock
      • Typedef CE::Memory::Ordering::ByteHeadOrder
      • Typedef CE::Memory::Ordering::BytePoolOrder
      • Typedef CE::Memory::Ordering::ByteRegistryOrder
      • Typedef CE::Memory::Shared
      • Typedef CE::Rendering::OpenGL::NativeEnum
      • Typedef CE::Rendering::OpenGL::NativeHandle
      • Typedef CE::Rendering::OpenGL::NativeInteger
      • Typedef CE::Rendering::Parameters::Contract
      • Typedef CE::Rendering::Parameters::Set
      • Typedef CE::Rendering::Parameters::Value
      • Typedef CE::Runtime::ShutdownPolicyCallback
      • Typedef CE::Runtime::Simulation::Clock
      • Typedef CE::Runtime::SimulationViewSource
      • Typedef CE::Runtime::WindowStateSource
      • Typedef CE::Text::FontSource
      • Typedef CE::Text::Legacy::BitmapFontData
      • Typedef CE::Text::Legacy::FontResources
      • Typedef CE::Text::Legacy::Store
      • Typedef CE::Text::Numbers::NumberVariant
      • Typedef CE::Time::ElapsedDuration
      • Typedef CE::Time::Hours
      • Typedef CE::Time::Milliseconds
      • Typedef CE::Time::Minutes
      • Typedef CE::Time::Seconds
      • Concept CE::Events::EventPayload
      • Concept CE::Memory::Objects::ReservableManager
      • Concept CE::Memory::Objects::ReservationAllocator

Game Development

  • Project setup
    • Choose modules
    • Source and SDK integration
  • Tutorials
    • First game
    • Actor controllers and commands
    • PlayerController
    • Character
    • AIController
    • UIController
    • HUD with TGUI
    • Event
    • Abstract controller interfaces
  • Task index
  • Guides by topic
    • Assets and animation
      • Load and publish assets
      • Author graphics manifests
      • Play sprite animation
      • Animate sprites and select tiles
      • Discover files and font candidates
      • Install optional artwork packages
    • Rendering and resources
      • Draw a whole image
      • Position objects with a camera
      • Submit frames and configure materials
      • Manage caches, publication and retirement
      • OpenGL backend reference
    • Input
      • Bind input actions
      • Actions, records, capture and focus
    • Text and fonts
      • Display and update text
      • Configure fonts and prepare text
      • Decode UTF-8 and interpret source indices
      • Use legacy bitmap fonts
    • GUI
      • Create an interactive GUI with RmlUi
      • TGUI reference
      • RmlUi reference
    • Audio
      • Control playback and ownership
      • miniaudio reference
    • Runtime and concurrency
      • Ownership and cleanup
      • Threads and data flow
      • Initialize, run and stop a session
      • Choose simulation timing and recovery
      • Observe and operate windows
      • Deliver typed events
      • Dispatch to an owner thread
      • Configure worker pools and groups
      • Application startup reference
      • Worker configuration and topology
      • Native GLFW platform reference
    • Memory, state and utilities
      • Use pools, reservations and release contexts
      • Track state and use time, number and geometry helpers
    • Logging and diagnostics
      • Configure logging and investigate missing records
      • Investigate runtime and resource symptoms
      • Handle native and cleanup failures
      • Linux output viewer
  • Engine Systems
    • Diagram explorer
    • Runtime
    • Display
    • Input
    • Assets
    • Resources
    • Rendering
    • Text
    • GUI
    • Audio
    • Events
    • Dispatch
    • Workers
    • Memory
    • State
    • Logging
    • Diagnostics
    • Utilities

Engine Development

  • Contributing
    • C++ code style
  • Build the engine and SDKs
  • Module authoring
    • Integration contracts
    • UI adapter authoring
  • Testing and validation
    • Component and SDK checks
    • Logging checks
    • Desktop and controller checks
  • Documentation tooling
    • Publishing documentation
  • CI and SDK artifacts
Cheryl Engine
  • C++ API
  • C++ API reference
  • Namespace CE::Memory::Objects
  • View page source

Namespace CE::Memory::Objects

Contents

  • Classes

Classes

  • Template Struct Constructor

  • Template Struct Factory

  • Template Struct Pool

  • Template Struct PoolState

  • Class Constructor::Context

  • Template Class Reservation

Previous Next

© Copyright 2026, Cheryl Engine contributors.

Built with Sphinx using a theme provided by Read the Docs.

Source revision: 3542f883391d · Build details · Declaring source