API Reference

Class Hierarchy

• • Namespace Cacao
    • Struct ClientIdentity
    • Struct Vertex
    • Class Actor
    • Class ActorHandle
    • Class Asset
    • Class AudioManager
    • Class BinaryBlobResource
    • Class BlobResource
    • Class Camera
    • Class CommandBuffer
    • Class Component
    • Class ComponentExporter
    • Class Cubemap
    • Template Class DataEvent
    • Class Engine
      • Struct Engine::Config
      • Struct Engine::InitConfig
    • Class Event
    • Class EventConsumer
    • Class EventManager
    • Template Class Flushable
    • Class GPUManager
    • Class Logger
      • Struct Logger::LogToken
    • Class Mesh
    • Class Model
    • Template Class MultiFuture
    • Class PAL
    • Class PerspectiveCamera
    • Class Resource
    • Class ResourceManager
    • Class Script
    • Class Sound
    • Class Tex2D
    • Class TextBlobResource
    • Class ThreadPool
    • Class TickController
    • Class Transform
    • Class Window
    • Class World

File Hierarchy

• • Directory engine
    • Directory include
      • Directory Cacao
        • File Actor.hpp
        • File Asset.hpp
        • File AudioManager.hpp
        • File Camera.hpp
        • File Component.hpp
        • File ComponentExporter.hpp
        • File Cubemap.hpp
        • File DllHelper.hpp
        • File Engine.hpp
        • File Event.hpp
        • File EventConsumer.hpp
        • File EventManager.hpp
        • File Exceptions.hpp
        • File Flushable.hpp
        • File GPU.hpp
        • File Identity.hpp
        • File Log.hpp
        • File Mesh.hpp
        • File Model.hpp
        • File MultiFuture.hpp
        • File PAL.hpp
        • File PerspectiveCamera.hpp
        • File Resource.hpp
        • File ResourceManager.hpp
        • File Script.hpp
        • File Sound.hpp
        • File Tex2D.hpp
        • File ThreadPool.hpp
        • File TickController.hpp
        • File Time.hpp
        • File Transform.hpp
        • File Window.hpp
        • File World.hpp

Full API

Namespaces

• Namespace Cacao
  • Namespaces
  • Classes
  • Functions

• Namespace Cacao::time
  • Typedefs

Classes and Structs

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

• Struct Engine::Config
  • Nested Relationships
  • Struct Documentation
    • Config
      • Config::fixedTickRate
      • Config::maxFrameLag
      • Config::alwaysRerenderUI

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

• Struct Logger::LogToken
  • Nested Relationships
  • Struct Documentation
    • LogToken
      • LogToken::LogToken()
      • LogToken::LogToken()
      • LogToken::LogToken()
      • LogToken::operator=()
      • LogToken::operator=()
      • LogToken::operator<<()
      • LogToken::~LogToken()
      • LogToken::lvl
      • LogToken::oss
      • LogToken::isClient

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

• Class Actor
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Actor
      • Actor::GetWorldTransformMatrix()
      • Actor::GetParent()
      • Actor::IsActive()
      • Actor::SetActive()
      • Actor::Reparent()
      • Actor::MountComponent()
      • Actor::MountComponent()
      • Actor::HasComponent()
      • Actor::GetComponent()
      • Actor::DeleteComponent()
      • Actor::GetAllComponents()
      • Actor::GetAllChildren()
      • Actor::~Actor()
      • Actor::name
      • Actor::guid
      • Actor::transform
      • Actor::Create()
      • Actor::Create()

• Class ActorHandle
  • Class Documentation
    • ActorHandle
      • ActorHandle::ActorHandle()
      • ActorHandle::operator->()
      • ActorHandle::operator->()
      • ActorHandle::IsNull()

• Class Asset
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • Asset
      • Asset::Realize()
      • Asset::RealizeAsync()
      • Asset::DropRealized()
      • Asset::IsRealized()
      • Asset::~Asset()
      • Asset::Asset()
      • Asset::realized

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

• Class BinaryBlobResource
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • BinaryBlobResource
      • BinaryBlobResource::GetData()
      • BinaryBlobResource::Create()

• Class BlobResource
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • BlobResource
      • BlobResource::BlobResource()

• Class Camera
  • Inheritance Relationships
    • Derived Type
  • Class Documentation
    • Camera
      • Camera::Camera()
      • Camera::~Camera()
      • Camera::GetPosition()
      • Camera::SetPosition()
      • Camera::GetRotation()
      • Camera::SetRotation()
      • Camera::GetProjectionMatrix()
      • Camera::GetViewMatrix()
      • Camera::ResizeProjectionMatrix()

• Class CommandBuffer
  • Class Documentation
    • CommandBuffer
      • CommandBuffer::CommandBuffer()
      • CommandBuffer::Execute()
      • CommandBuffer::~CommandBuffer()

• Class Component
  • Inheritance Relationships
    • Derived Type
  • Class Documentation
    • Component
      • Component::IsEnabled()
      • Component::SetEnabled()
      • Component::GetOwner()
      • Component::~Component()
      • Component::Component()
      • Component::OnMount()
      • Component::OnEnable()
      • Component::OnDisable()
      • Component::actor

• Class ComponentExporter
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • ComponentExporter
      • ComponentExporter::Instantiate()
      • ComponentExporter::type
      • ComponentExporter::Create()

• Class Cubemap
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Cubemap
      • Cubemap::Realize()
      • Cubemap::RealizeAsync()
      • Cubemap::DropRealized()
      • Cubemap::~Cubemap()
      • Cubemap::Create()

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

• Class Engine
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • Engine
      • Engine::State
        • Engine::State::Dead
        • Engine::State::Alive
        • Engine::State::Ready
        • Engine::State::Running
      • Engine::GetInitConfig()
      • Engine::GetDataDirectory()
      • Engine::RunTaskOnMainThread()
      • Engine::CoreInit()
      • Engine::GfxInit()
      • Engine::Run()
      • Engine::Quit()
      • Engine::GfxShutdown()
      • Engine::CoreShutdown()
      • Engine::GetState()
      • Engine::config
      • Engine::Get()
      • Engine::Config
        • Engine::Config::fixedTickRate
        • Engine::Config::maxFrameLag
        • Engine::Config::alwaysRerenderUI
      • Engine::InitConfig
        • Engine::InitConfig::standalone
        • Engine::InitConfig::initialRequestedBackend
        • Engine::InitConfig::preferredWindowProvider
        • Engine::InitConfig::suppressConsoleLogging
        • Engine::InitConfig::suppressFileLogging
        • Engine::InitConfig::clientID

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

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

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

• Template Class Flushable
  • Class Documentation
    • Flushable
      • Flushable::Flushable()
      • Flushable::operator->()
      • Flushable::operator=()
      • Flushable::Flush()

• Class GPUManager
  • Class Documentation
    • GPUManager
      • GPUManager::Start()
      • GPUManager::Stop()
      • GPUManager::IsRunning()
      • GPUManager::Submit()
      • GPUManager::SetVSync()
      • GPUManager::Get()

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

• Class Mesh
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Mesh
      • Mesh::Realize()
      • Mesh::RealizeAsync()
      • Mesh::DropRealized()
      • Mesh::~Mesh()
      • Mesh::Create()

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

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

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

• Class PerspectiveCamera
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • PerspectiveCamera
      • PerspectiveCamera::PerspectiveCamera()
      • PerspectiveCamera::GetPosition()
      • PerspectiveCamera::SetPosition()
      • PerspectiveCamera::GetRotation()
      • PerspectiveCamera::SetRotation()
      • PerspectiveCamera::GetFOV()
      • PerspectiveCamera::SetFOV()
      • PerspectiveCamera::GetProjectionMatrix()
      • PerspectiveCamera::GetViewMatrix()
      • PerspectiveCamera::GetFrontVector()
      • PerspectiveCamera::GetRightVector()
      • PerspectiveCamera::GetUpVector()
      • PerspectiveCamera::GetLookTarget()
      • PerspectiveCamera::ResizeProjectionMatrix()

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

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

• Class Script
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Script
      • Script::OnEnable()
      • Script::OnDisable()
      • Script::OnDynTick()
      • Script::OnFixedTick()
      • Script::Script()

• Class Sound
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Sound
      • Sound::Realize()
      • Sound::RealizeAsync()
      • Sound::DropRealized()
      • Sound::~Sound()
      • Sound::Create()

• Class Tex2D
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Tex2D
      • Tex2D::Realize()
      • Tex2D::RealizeAsync()
      • Tex2D::DropRealized()
      • Tex2D::~Tex2D()
      • Tex2D::Create()

• Class TextBlobResource
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • TextBlobResource
      • TextBlobResource::GetData()
      • TextBlobResource::Create()

• Class ThreadPool
  • Class Documentation
    • ThreadPool
      • ThreadPool::Exec()
      • ThreadPool::ExecContinuous()
      • ThreadPool::Start()
      • ThreadPool::Stop()
      • ThreadPool::IsRunning()
      • ThreadPool::GetThreadCount()
      • ThreadPool::Get()

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

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

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

• Class World
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • World
      • World::ReparentToRoot()
      • World::GetRootChildren()
      • World::FindActor()
      • World::~World()
      • World::cam
      • World::skyboxTex
      • World::Create()
      • World::Create()

Functions

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

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

Typedefs

• Typedef Cacao::time::dhours
  • Typedef Documentation
    • dhours

• Typedef Cacao::time::dmicroseconds
  • Typedef Documentation
    • dmicroseconds

• Typedef Cacao::time::dmilliseconds
  • Typedef Documentation
    • dmilliseconds

• Typedef Cacao::time::dminutes
  • Typedef Documentation
    • dminutes

• Typedef Cacao::time::dnanoseconds
  • Typedef Documentation
    • dnanoseconds

• Typedef Cacao::time::dseconds
  • Typedef Documentation
    • dseconds

• Typedef Cacao::time::dtime_point
  • Typedef Documentation
    • dtime_point

• Typedef Cacao::time::fhours
  • Typedef Documentation
    • fhours

• Typedef Cacao::time::fmicroseconds
  • Typedef Documentation
    • fmicroseconds

• Typedef Cacao::time::fmilliseconds
  • Typedef Documentation
    • fmilliseconds

• Typedef Cacao::time::fminutes
  • Typedef Documentation
    • fminutes

• Typedef Cacao::time::fnanoseconds
  • Typedef Documentation
    • fnanoseconds

• Typedef Cacao::time::fseconds
  • Typedef Documentation
    • fseconds

• Typedef Cacao::time::ftime_point
  • Typedef Documentation
    • ftime_point