API Reference

Class Hierarchy

• • Namespace Cacao
    • Namespace Cacao::Reactivity
      • Template Class Computed
      • Class Dependency
      • Class EffectOutput
      • Template Class ExternalBinding
      • Class SideEffect
      • Template Class State
        • Class State::MutationProxy
    • Struct ClientIdentity
    • Struct Vertex
    • Class Actor
    • Class ActorRef
    • Class Asset
    • Class AudioManager
    • Class AudioPlayer
    • Class BlobResource
    • Class Camera
    • Class CodeRegistry
    • Class CommandBuffer
    • Class Component
    • Class Cubemap
    • Template Class DataEvent
    • Class Engine
      • Struct Engine::InitConfig
      • Struct Engine::RuntimeConfig
    • Class Event
    • Class EventConsumer
    • Class EventManager
    • Class GPUManager
    • Class Input
    • Class Logger
      • Struct Logger::LogToken
    • Class Material
    • Class Mesh
    • Class MeshRenderer
    • Class Model
    • Template Class MultiFuture
    • Class OrthographicCamera
    • Class PAL
    • Class PerspectiveCamera
    • Class Resource
    • Class ResourceManager
    • Class Script
    • Class Shader
    • Class Sound
    • Class Tex2D
    • Class TickController
    • Class Transform
    • Class Window
    • Class World
    • Class WorldManager
  • Template Struct astra

File Hierarchy

• • Directory engine
    • Directory include
      • Directory Cacao
        • File Actor.hpp
        • File Asset.hpp
        • File AudioManager.hpp
        • File AudioPlayer.hpp
        • File Camera.hpp
        • File CodeRegistry.hpp
        • File Cubemap.hpp
        • File Engine.hpp
        • File Event.hpp
        • File EventConsumer.hpp
        • File EventManager.hpp
        • File Exceptions.hpp
        • File GPU.hpp
        • File Identity.hpp
        • File Input.hpp
        • File Log.hpp
        • File Material.hpp
        • File Mesh.hpp
        • File MeshRenderer.hpp
        • File Model.hpp
        • File MultiFuture.hpp
        • File OrthographicCamera.hpp
        • File PAL.hpp
        • File PerspectiveCamera.hpp
        • File Reactivity.hpp
        • File Resource.hpp
        • File ResourceManager.hpp
        • File Script.hpp
        • File Shader.hpp
        • File Sound.hpp
        • File Substitutes.hpp
        • File Tex2D.hpp
        • File TickController.hpp
        • File Transform.hpp
        • File Window.hpp
        • File World.hpp
        • File WorldManager.hpp

Full API

Namespaces

• Namespace Cacao
  • Namespaces
  • Classes
  • Functions

• Namespace Cacao::Reactivity
  • Classes

Concepts

• Concept Loader
  • Concept Documentation
    • Loader

• Concept MultiLoader
  • Concept Documentation
    • MultiLoader

Classes and Structs

• Template Struct astra
  • Inheritance Relationships
    • Base Types
  • Struct Documentation
    • ASTRA_SUBSTITUTE_SERIALIZE()
    • ASTRA_SUBSTITUTE_DESERIALIZE()
    • SerializedSubstitute()
    • ASTRA_SUBSTITUTE_SERIALIZE()
    • ASTRA_SUBSTITUTE_DESERIALIZE()
    • ASTRA_SUBSTITUTE_SERIALIZE()
    • ASTRA_SUBSTITUTE_DESERIALIZE()
    • ASTRA_SUBSTITUTE_SERIALIZE()
    • ASTRA_SUBSTITUTE_DESERIALIZE()
    • ASTRA_SUBSTITUTE_SERIALIZE()
    • ASTRA_SUBSTITUTE_DESERIALIZE()
    • ASTRA_SUBSTITUTE_SERIALIZE()
    • ASTRA_SUBSTITUTE_DESERIALIZE()
    • ASTRA_SUBSTITUTE_SERIALIZE()
    • ASTRA_SUBSTITUTE_DESERIALIZE()
    • ASTRA_SUBSTITUTE_SERIALIZE()
    • ASTRA_SUBSTITUTE_DESERIALIZE()
    • ASTRA_SUBSTITUTE_SERIALIZE()
    • ASTRA_SUBSTITUTE_DESERIALIZE()
    • ASTRA_SUBSTITUTE_SERIALIZE()
    • ASTRA_SUBSTITUTE_DESERIALIZE()
    • data
    • x
    • y
    • z
    • w
    • guid
    • worldAddr
    • mesh
    • material
    • sound
    • autoplay
    • loop
    • gain
    • pitchMultiplier
    • playbackPosition
    • position
    • rotation
    • scale

• Struct ClientIdentity
  • Struct Documentation
    • Cacao::ClientIdentity
      • id
      • displayName

• Struct Engine::InitConfig
  • Nested Relationships
  • Struct Documentation
    • Cacao::Engine::InitConfig
      • initialRequestedBackend
      • preferredWindowProvider
      • suppressConsoleLogging
      • suppressFileLogging
      • clientID

• Struct Engine::RuntimeConfig
  • Nested Relationships
  • Struct Documentation
    • Cacao::Engine::RuntimeConfig
      • alwaysRerenderUI
      • maxTPS
      • verboseInputLogging

• Struct Logger::LogToken
  • Nested Relationships
  • Struct Documentation
    • Cacao::Logger::LogToken
      • Source
        • Client
        • Runtime
        • Engine
      • LogToken()
      • LogToken()
      • LogToken()
      • operator=()
      • operator=()
      • operator<<()
      • LogFormatted()
      • LogFormatted()
      • ~LogToken()
      • lvl
      • oss
      • src

• Struct Vertex
  • Struct Documentation
    • Cacao::Vertex
      • Vertex()
      • position
      • texCoords
      • normal
      • tangent

• Class Actor
  • Class Documentation
    • Cacao::Actor
      • GetLocalTransform()
      • SetLocalTransform()
      • GetWorldTransformationMatrix()
      • GetWorldTransform()
      • GetParent()
      • IsActive()
      • SetActive()
      • Reparent()
      • HasComponent()
      • MountComponent()
      • MountComponent()
      • MountComponent()
      • GetComponent()
      • UnmountComponent()
      • GetAllComponents()
      • GetComponentsFiltered()
      • GetAllChildren()
      • name
      • guid

• Class ActorRef
  • Class Documentation
    • Cacao::ActorRef
      • ActorRef()
      • operator->()
      • operator->()
      • GetWorld()
      • GetWorld()
      • operator bool()
      • operator==()

• Class Asset
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • Cacao::Asset
      • Bake()
      • Discard()
      • IsBaked()
      • ~Asset()
      • Asset()
      • baked

• Class AudioManager
  • Class Documentation
    • Cacao::AudioManager
      • Initialize()
      • Terminate()
      • IsInitialized()
      • SetGlobalGain()
      • GetGlobalGain()
      • Get()

• Class AudioPlayer
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::AudioPlayer
      • AudioPlayer()
      • autoplay

• Class BlobResource
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::BlobResource
      • GetData()
      • GetDataAsString()
      • Create()
      • Create()

• Class Camera
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • Cacao::Camera
      • Camera()
      • ~Camera()
      • GetPosition()
      • SetPosition()
      • GetRotation()
      • GetRotationEuler()
      • SetRotation()
      • SetRotationEuler()
      • GetProjectionMatrix()
      • GetViewMatrix()
      • GetFrontVector()
      • GetRightVector()
      • GetUpVector()
      • GetLookTarget()
      • GetClearColor()
      • SetClearColor()
      • ResizeProjectionMatrix()
      • RecalculateViewMatrix()
      • RecalculateProjectionMatrix()
      • RecalculateCameraVectors()
      • resizeConsumer
      • clearColor
      • projectionMatrix
      • viewMatrix
      • viewProjectionMatrix
      • position
      • rotation
      • frontVec
      • upVec
      • rightVec
      • displaySize

• Class CodeRegistry
  • Class Documentation
    • Cacao::CodeRegistry
      • RegisterFactory()
      • HasFactory()
      • Instantiate()
      • ClearAllFactories()
      • Get()

• Class CommandBuffer
  • Class Documentation
    • Cacao::CommandBuffer
      • DrawMesh()
      • ~CommandBuffer()
      • Create()
      • CommandBuffer()
      • Execute()
      • SetupContext()
      • StartRendering()
      • EndRendering()
      • UpdateEngineData()

• Class Component
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • Cacao::Component
      • IsEnabled()
      • SetEnabled()
      • GetOwner()
      • ~Component()
      • OnMount()
      • OnUnmount()
      • OnEnable()
      • OnDisable()

• Class Cubemap
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::Cubemap
      • Bake()
      • Discard()
      • ~Cubemap()
      • Create()

• Template Class DataEvent
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::DataEvent
      • DataEvent()
      • GetData()

• Class Engine
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • Cacao::Engine
      • State
        • Dead
        • Alive
        • Ready
        • Running
      • GetInitConfig()
      • GetRuntimeConfig()
      • GetDataDirectory()
      • GetThreadPool()
      • RunTaskOnMainThread()
      • CoreInit()
      • GfxInit()
      • Run()
      • Quit()
      • GfxShutdown()
      • CoreShutdown()
      • GetState()
      • Get()
      • Cacao::Engine::InitConfig
        • initialRequestedBackend
        • preferredWindowProvider
        • suppressConsoleLogging
        • suppressFileLogging
        • clientID
      • Cacao::Engine::RuntimeConfig
        • alwaysRerenderUI
        • maxTPS
        • verboseInputLogging

• Class Event
  • Inheritance Relationships
    • Derived Type
  • Class Documentation
    • Cacao::Event
      • Event()
      • GetType()
      • type

• Class EventConsumer
  • Class Documentation
    • Cacao::EventConsumer
      • EventConsumer()
      • EventConsumer()
      • Consume()
      • operator==()

• Class EventManager
  • Class Documentation
    • Cacao::EventManager
      • SubscribeConsumer()
      • UnsubscribeConsumer()
      • UnsubscribeAllConsumers()
      • Dispatch()
      • Get()

• Class GPUManager
  • Class Documentation
    • Cacao::GPUManager
      • Phase
        • Opaque
        • Transparent
      • Start()
      • Stop()
      • IsRunning()
      • Submit()
      • SetVSync()
      • IsVSynced()
      • GetCurrentFPS()
      • RegisterRenderingCallback()
      • UnregisterRenderingCallback()
      • Get()

• Class Input
  • Class Documentation
    • Cacao::Input
      • GetCursorPos()
      • IsKeyPressed()
      • IsMouseButtonPressed()
      • Get()

• Class Logger
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • Cacao::Logger
      • Level
        • Trace
        • Info
        • Warn
        • Error
        • Fatal
      • Get()
      • Engine()
      • Runtime()
      • Client()
      • Cacao::Logger::LogToken
        • Source
        • LogToken()
        • LogToken()
        • LogToken()
        • operator=()
        • operator=()
        • operator<<()
        • LogFormatted()
        • LogFormatted()
        • ~LogToken()
        • lvl
        • oss
        • src

• Class Material
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::Material
      • ParamValue
      • GetShader()
      • SetParameter()
      • GetParameter()
      • SetRenderMode()
      • GetRenderMode()
      • ~Material()
      • Create()

• Class Mesh
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::Mesh
      • Bake()
      • Discard()
      • ~Mesh()
      • Create()

• Class MeshRenderer
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::MeshRenderer
      • MeshRenderer()

• Class Model
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::Model
      • ListMeshes()
      • ListTextures()
      • GetMesh()
      • GetTexture()
      • ~Model()
      • Create()

• Template Class MultiFuture
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::MultiFuture
      • MultiFuture()
      • operator=()
      • WaitAll()
      • NumReadyFutures()

• Class OrthographicCamera
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::OrthographicCamera
      • OrthographicCamera()
      • GetZoomFactor()
      • SetZoomFactor()

• Class PAL
  • Class Documentation
    • Cacao::PAL
      • SetModule()
      • InitializeModule()
      • GfxConnect()
      • GfxDisconnect()
      • TerminateModule()
      • ConfigureImplPtr()
      • Get()

• Class PerspectiveCamera
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::PerspectiveCamera
      • PerspectiveCamera()
      • GetFOV()
      • SetFOV()
      • RecalculateProjectionMatrix()
      • fov

• Template Class Computed
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::Reactivity::Computed
      • Computed()
      • operator const T &()
      • operator->()

• Class Dependency
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • Cacao::Reactivity::Dependency
      • EvalReadOk()
      • EvalWriteOk()

• Class EffectOutput
  • Inheritance Relationships
    • Derived Type
  • Class Documentation
    • Cacao::Reactivity::EffectOutput

• Template Class ExternalBinding
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::Reactivity::ExternalBinding
      • ExternalBinding()
      • operator const T &()
      • operator->()

• Class SideEffect
  • Class Documentation
    • Cacao::Reactivity::SideEffect
      • SideEffect()

• Template Class State
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • Cacao::Reactivity::State
      • State()
      • State()
      • operator const T &()
      • operator->()
      • operator=()
      • operator=()
      • Modify()
      • Cacao::Reactivity::State::MutationProxy
        • operator T&()
        • operator->()
        • ~MutationProxy()

• Class State::MutationProxy
  • Nested Relationships
  • Class Documentation
    • Cacao::Reactivity::State::MutationProxy
      • operator T&()
      • operator->()
      • ~MutationProxy()

• Class Resource
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • Cacao::Resource
      • GetAddress()
      • ~Resource()
      • ValidateResourceAddr()
      • Resource()
      • address

• Class ResourceManager
  • Class Documentation
    • Cacao::ResourceManager
      • Load()
      • ConfigureResourceLoader()
      • Get()

• Class Script
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::Script
      • OnDynTick()
      • Script()

• Class Shader
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::Shader
      • GetDescriptor()
      • Bake()
      • Discard()
      • ~Shader()
      • Create()

• Class Sound
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::Sound
      • Bake()
      • Discard()
      • ~Sound()
      • Create()

• Class Tex2D
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::Tex2D
      • Bake()
      • Discard()
      • ~Tex2D()
      • Create()

• Class TickController
  • Class Documentation
    • Cacao::TickController
      • Start()
      • Stop()
      • IsRunning()
      • GetCurrentTPS()
      • Get()

• Class Transform
  • Class Documentation
    • Cacao::Transform
      • Transform()
      • Transform()
      • Transform()
      • GetPosition()
      • GetRotation()
      • GetRotationEuler()
      • GetScale()
      • SetPosition()
      • SetRotation()
      • SetRotationEuler()
      • SetScale()
      • GetTransformationMatrix()

• Class Window
  • Class Documentation
    • Cacao::Window
      • Mode
        • Windowed
        • Borderless
        • Fullscreen
      • Open()
      • Close()
      • HandleOSEvents()
      • Show()
      • Hide()
      • SetTitle()
      • Resize()
      • SetMode()
      • IsOpen()
      • IsVisible()
      • IsMinimized()
      • GetTitle()
      • GetSize()
      • GetContentAreaSize()
      • GetMode()
      • Get()

• Class World
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cacao::World
      • MakeToplevel()
      • GetToplevelActors()
      • CreateActor()
      • FindActors()
      • GetSkyboxRotation()
      • GetSkyboxRotationEuler()
      • SetSkyboxRotation()
      • SetSkyboxRotationEuler()
      • ~World()
      • cam
      • skyboxTex
      • Create()
      • Create()

• Class WorldManager
  • Class Documentation
    • Cacao::WorldManager
      • SetActiveWorld()
      • GetActiveWorld()
      • GetActiveWorldAddr()
      • Get()

Functions

• Template Function Cacao::Check(bool, std::string_view, std::function<void()>)
  • Function Documentation
    • Check()

• Template Function Cacao::Check(std::shared_ptr<P>, std::string_view, std::function<void()>)
  • Function Documentation
    • Check()

Variables

• Variable Paused
  • Variable Documentation

• Variable Playing
  • Variable Documentation