What the editor knows about a platform: its identity, the framework whose backend builds for it, that backend's settings (carried, not interpreted), its screen, compiler flags, what it offers packages and what it needs from them, and the scene it boots. More...

#include <C:/Users/kirby/Documents/Github/deki/deki-editor/deki-editor/include/deki-editor/build/PlatformConfig.h>

Public Member Functions
std::string	Option (const std::string &key, const std::string &fallback="") const
	Reads one value out of frameworkOptions.
uint32_t	OptionU32 (const std::string &key, uint32_t fallback=0) const
bool	OptionBool (const std::string &key, bool fallback=false) const
std::vector< std::string >	OptionList (const std::string &key) const
void	SetOption (const std::string &key, const std::string &value)
	Sets one value, creating the object if needed.
void	SetOptionU32 (const std::string &key, uint32_t value)
void	SetOptionBool (const std::string &key, bool value)
void	SetOptionList (const std::string &key, const std::vector< std::string > &values)
std::set< std::string >	Capabilities () const
	provides, plus "framework:<framework>" and "family:<family>" derived from this config.

Public Attributes
std::string	id
std::string	displayName
std::string	family
std::string	framework
std::string	frameworkOptions
uint32_t	externalMemorySize = 0
int	screenWidth = 0
int	screenHeight = 0
std::string	colorFormat
std::vector< std::string >	defines
std::vector< std::string >	cFlags
std::vector< std::string >	cxxFlags
std::vector< std::string >	linkFlags
std::vector< std::string >	provides
std::vector< std::string >	requiresPackages
std::string	assetStorage = "internal"
std::string	bootScene

Detailed Description

What the editor knows about a platform: its identity, the framework whose backend builds for it, that backend's settings (carried, not interpreted), its screen, compiler flags, what it offers packages and what it needs from them, and the scene it boots.

Member Function Documentation

◆ Option()

std::string DekiEditor::PlatformConfig::Option	(	const std::string &	key,
		const std::string &	fallback = "" ) const

Reads one value out of frameworkOptions.

A missing or wrong-typed key gives the fallback, so a builder need not guard every lookup.

◆ OptionU32()

uint32_t DekiEditor::PlatformConfig::OptionU32	(	const std::string &	key,
		uint32_t	fallback = 0 ) const

◆ OptionBool()

bool DekiEditor::PlatformConfig::OptionBool	(	const std::string &	key,
		bool	fallback = false ) const

◆ OptionList()

std::vector< std::string > DekiEditor::PlatformConfig::OptionList ( const std::string & key ) const

◆ SetOption()

void DekiEditor::PlatformConfig::SetOption	(	const std::string &	key,
		const std::string &	value )

Sets one value, creating the object if needed.

For the platform editor and the MCP tool, which do not know what the keys mean.

◆ SetOptionU32()

void DekiEditor::PlatformConfig::SetOptionU32	(	const std::string &	key,
		uint32_t	value )

◆ SetOptionBool()

void DekiEditor::PlatformConfig::SetOptionBool	(	const std::string &	key,
		bool	value )

◆ SetOptionList()

void DekiEditor::PlatformConfig::SetOptionList	(	const std::string &	key,
		const std::vector< std::string > &	values )

◆ Capabilities()

std::set< std::string > DekiEditor::PlatformConfig::Capabilities ( ) const

provides, plus "framework:<framework>" and "family:<family>" derived from this config.

A package truly tied to one toolchain can require those without anyone writing a new list.

Member Data Documentation

◆ id

std::string DekiEditor::PlatformConfig::id

◆ displayName

std::string DekiEditor::PlatformConfig::displayName

◆ family

std::string DekiEditor::PlatformConfig::family

◆ framework

std::string DekiEditor::PlatformConfig::framework

◆ frameworkOptions

std::string DekiEditor::PlatformConfig::frameworkOptions

◆ externalMemorySize

uint32_t DekiEditor::PlatformConfig::externalMemorySize = 0

◆ screenWidth

int DekiEditor::PlatformConfig::screenWidth = 0

◆ screenHeight

int DekiEditor::PlatformConfig::screenHeight = 0

◆ colorFormat

std::string DekiEditor::PlatformConfig::colorFormat

◆ defines

std::vector<std::string> DekiEditor::PlatformConfig::defines

◆ cFlags

std::vector<std::string> DekiEditor::PlatformConfig::cFlags

◆ cxxFlags

std::vector<std::string> DekiEditor::PlatformConfig::cxxFlags

◆ linkFlags

std::vector<std::string> DekiEditor::PlatformConfig::linkFlags

◆ provides

std::vector<std::string> DekiEditor::PlatformConfig::provides

◆ requiresPackages

std::vector<std::string> DekiEditor::PlatformConfig::requiresPackages

◆ assetStorage

std::string DekiEditor::PlatformConfig::assetStorage = "internal"

◆ bootScene

std::string DekiEditor::PlatformConfig::bootScene

The documentation for this struct was generated from the following file:

deki-editor/include/deki-editor/build/PlatformConfig.h

Public Member Functions

Public Attributes