Structure containing an Engine configuration. More...

#include <SG_Com.h>

Collaboration diagram for SG_COM_EngineConfig:

Data Fields
sg_byte *	character_file_in_memory
	The character file loaded into a memory buffer.

sg_size	character_file_bytes
	The size of the loaded character file in bytes.

SG_AudioSampleType	audio_sample_type
	The input audio sample type.

SG_AudioSampleRate	audio_sample_rate
	The input audio sample rate.

SG_COM_PlayerHandle	local_player
	A handle to a Player object that can be used to create local animation output from this engine.

SG_COM_EngineBroadcastCallback	engine_broadcast_callback
	Callback to broadcast packets to remote Players (nullptr if not broadcasting).

SG_COM_EngineStatusCallback	engine_status_callback
	Callback for Engine status updates.

float	buffer_sec
	The maximum duration (in seconds) that the input buffer can hold.

SG_COM_EngineConfigFlag	flag
	Combination of engine configuration flags to enable/disable features.

void *	custom_engine_data
	Custom user data (or nullptr).

Detailed Description

Structure containing an Engine configuration.

Definition at line 143 of file SG_Com.h.

Field Documentation

◆ audio_sample_rate

SG_AudioSampleRate SG_COM_EngineConfig::audio_sample_rate

The input audio sample rate.

Definition at line 147 of file SG_Com.h.

◆ audio_sample_type

SG_AudioSampleType SG_COM_EngineConfig::audio_sample_type

The input audio sample type.

Definition at line 146 of file SG_Com.h.

◆ buffer_sec

float SG_COM_EngineConfig::buffer_sec

The maximum duration (in seconds) that the input buffer can hold.

Definition at line 151 of file SG_Com.h.

◆ character_file_bytes

sg_size SG_COM_EngineConfig::character_file_bytes

The size of the loaded character file in bytes.

Definition at line 145 of file SG_Com.h.

◆ character_file_in_memory

sg_byte* SG_COM_EngineConfig::character_file_in_memory

The character file loaded into a memory buffer.

Definition at line 144 of file SG_Com.h.

◆ custom_engine_data

void* SG_COM_EngineConfig::custom_engine_data

Custom user data (or nullptr).

Definition at line 153 of file SG_Com.h.

◆ engine_broadcast_callback

SG_COM_EngineBroadcastCallback SG_COM_EngineConfig::engine_broadcast_callback

Callback to broadcast packets to remote Players (nullptr if not broadcasting).

Definition at line 149 of file SG_Com.h.

◆ engine_status_callback

SG_COM_EngineStatusCallback SG_COM_EngineConfig::engine_status_callback

Callback for Engine status updates.

Definition at line 150 of file SG_Com.h.

◆ flag

SG_COM_EngineConfigFlag SG_COM_EngineConfig::flag

Combination of engine configuration flags to enable/disable features.

Definition at line 152 of file SG_Com.h.

◆ local_player

SG_COM_PlayerHandle SG_COM_EngineConfig::local_player

A handle to a Player object that can be used to create local animation output from this engine.

Definition at line 148 of file SG_Com.h.

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

SG_Com.h

Data Fields