Namespaces
	core
	typedef for Function Pointer

	gui

	io

	scene
	All scene management can be found in this namespace: Mesh loading, special scene nodes like octrees and billboards, ...

	video
	The video namespace contains classes for accessing the video driver. All 2d and 3d rendering is done here.

Classes
class	IEventReceiver
	Interface of an object which can receive events (SDL_Event*) More...

class	SagaDevice
	The Irrlicht device. You can create it with createDevice() or createDeviceEx(). More...

struct	SDeviceCreationParameters
	Structure for holding device creation parameters. More...

Typedefs
using	ID = std::uint32_t
	Type for node ID. More...

Enumerations
enum	E_DEVICE_TYPE { E_DEVICE_TYPE::SDL }
	An enum class for the different device types supported by the engine. More...

Functions
std::unique_ptr< SagaDevice >	createDevice (video::E_DRIVER_TYPE driverType=video::E_DRIVER_TYPE::VULKAN, const glm::uvec2 &windowSize={800, 600}, std::uint32_t bits=32, bool fullscreen=false, bool stencilbuffer=true, bool vsync=false)
	Creates an Saga device. The Saga device is the root object for using the engine. More...

std::unique_ptr< SagaDevice >	createDeviceEx (const SDeviceCreationParameters &parameters)
	typedef for Function Pointer More...

Variables
constexpr auto	INVALID_ID = 0

Typedef Documentation

◆ ID

using saga::ID = typedef std::uint32_t

Type for node ID.

Definition at line 11 of file ID.h.

Enumeration Type Documentation

◆ E_DEVICE_TYPE

enum saga::E_DEVICE_TYPE

strong

An enum class for the different device types supported by the engine.

Enumerator
SDL

Definition at line 8 of file EDeviceTypes.h.

Function Documentation

◆ createDevice()

std::unique_ptr<SagaDevice> saga::createDevice	(	video::E_DRIVER_TYPE	driverType = `video::E_DRIVER_TYPE::VULKAN`,
		const glm::uvec2 &	windowSize = `{800, 600}`,
		std::uint32_t	bits = `32`,
		bool	fullscreen = `false`,
		bool	stencilbuffer = `true`,
		bool	vsync = `false`
	)

Creates an Saga device. The Saga device is the root object for using the engine.

If you need more parameters to be passed to the creation of the Saga device, use the createDeviceEx() function.

Parameters

driverType	Type of the video driver to use. This can currently be video::E_DRIVER_TYPE::NULL_DRIVER, video::E_DRIVER_TYPE::SOFTWARE, video::E_DRIVER_TYPE::BURNINGSVIDEO, video::E_DRIVER_TYPE::DIRECT3D9 and video::E_DRIVER_TYPE::OPENGL.
windowSize	Size of the window or the video mode in fullscreen mode.
bits	Bits per pixel in fullscreen mode. Ignored if windowed mode.
fullscreen	Should be set to true if the device should run in fullscreen. Otherwise the device runs in windowed mode.
stencilbuffer	Specifies if the stencil buffer should be enabled. Set this to true, if you want the engine be able to draw stencil buffer shadows. Note that not all devices are able to use the stencil buffer. If they don't no shadows will be drawn.
vsync	Specifies vertical synchronization: If set to true, the driver will wait for the vertical retrace period, otherwise not.
receiver	A user created event receiver.

Returns: Returns pointer to the created SagaDevice or null if the device could not be created.

◆ createDeviceEx()

std::unique_ptr<SagaDevice> saga::createDeviceEx ( const SDeviceCreationParameters & parameters )

typedef for Function Pointer

Creates an Saga device with the option to specify advanced parameters. Usually you should used createDevice() for creating an Saga device. Use this function only if you wish to specify advanced parameters like a window handle in which the device should be created.

Parameters

parameters Structure containing advanced parameters for the creation of the device. See saga::SDeviceCreationParameters for details.

Returns: Returns pointer to the created IrrlichtDevice or null if the device could not be created.

Variable Documentation

◆ INVALID_ID

constexpr auto saga::INVALID_ID = 0

constexpr

Definition at line 9 of file ID.h.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables