Abstract base class for rendering backends. More...

#include <aeongames/Renderer.hpp>

Inheritance diagram for AeonGames::Renderer:

Collaboration diagram for AeonGames::Renderer:

Public Member Functions
virtual DLL	~Renderer ()=0
	Virtual destructor.
Renderer specific resource functions
virtual void	LoadMesh (const Mesh &aMesh)=0
	Loads mesh data into GPU memory.
virtual void	UnloadMesh (const Mesh &aMesh)=0
	Unloads mesh data from GPU memory.
virtual void	LoadPipeline (const Pipeline &aPipeline)=0
	Loads a rendering pipeline (shaders and state) into the renderer.
virtual void	UnloadPipeline (const Pipeline &aPipeline)=0
	Unloads a rendering pipeline from the renderer.
virtual void	LoadMaterial (const Material &aMaterial)=0
	Loads material data into the renderer.
virtual void	UnloadMaterial (const Material &aMaterial)=0
	Unloads material data from the renderer.
virtual void	LoadTexture (const Texture &aTexture)=0
	Loads a texture into GPU memory.
virtual void	UnloadTexture (const Texture &aTexture)=0
	Unloads a texture from GPU memory.
Window surface related functions
virtual void	AttachWindow (void *aWindowId)=0
	Attach a Window as a rendering surface.
virtual void	DetachWindow (void *aWindowId)=0
	Detach a Window as a rendering surface.
virtual void	SetProjectionMatrix (void *aWindowId, const Matrix4x4 &aMatrix)=0
	Sets the projection matrix for a specific window surface.
virtual void	SetViewMatrix (void *aWindowId, const Matrix4x4 &aMatrix)=0
	Sets the view matrix for a specific window surface.
virtual void	SetClearColor (void *aWindowId, float R, float G, float B, float A)=0
	Sets the color to be used to clear the window background.
virtual void	ResizeViewport (void *aWindowId, int32_t aX, int32_t aY, uint32_t aWidth, uint32_t aHeight)=0
	Resizes the specific window surface's viewport.
virtual void	BeginRender (void *aWindowId)=0
	Begins a render pass for the given window surface.
virtual void	EndRender (void *aWindowId)=0
	Ends the current render pass for the given window surface.
virtual void	Render (void aWindowId, const Matrix4x4 &aModelMatrix, const Mesh &aMesh, const Pipeline &aPipeline, const Material aMaterial=nullptr, const BufferAccessor *aSkeleton=nullptr, Topology aTopology=Topology::TRIANGLE_LIST, uint32_t aVertexStart=0, uint32_t aVertexCount=0xffffffff, uint32_t aInstanceCount=1, uint32_t aFirstInstance=0) const =0
	Issues a draw call for a mesh with the given pipeline and optional material.
virtual const Frustum &	GetFrustum (void *aWindowId) const =0
	Returns the view frustum for the given window surface.
virtual BufferAccessor	AllocateSingleFrameUniformMemory (void *aWindowId, size_t aSize)=0
	Allocates uniform buffer memory that is valid for a single frame.

Detailed Description

Abstract base class for rendering backends.

Defines the interface for loading and unloading GPU resources, managing window surfaces, and issuing draw calls. Concrete implementations provide API-specific logic (e.g., Vulkan, OpenGL).

Definition at line 43 of file Renderer.hpp.

Member Function Documentation

◆ AllocateSingleFrameUniformMemory()

virtual BufferAccessor AeonGames::Renderer::AllocateSingleFrameUniformMemory	(	void *	aWindowId,
		size_t	aSize )

pure virtual

Allocates uniform buffer memory that is valid for a single frame.

Parameters

aWindowId	Platform dependent window handle.
aSize	Size in bytes of the requested allocation.

Returns: A BufferAccessor to the allocated memory.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ AttachWindow()

virtual void AeonGames::Renderer::AttachWindow ( void * aWindowId )

pure virtual

Attach a Window as a rendering surface.

Parameters

aWindowId Platform depended window handle.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ BeginRender()

virtual void AeonGames::Renderer::BeginRender ( void * aWindowId )

pure virtual

Begins a render pass for the given window surface.

Parameters

aWindowId Platform dependent window handle.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ DetachWindow()

virtual void AeonGames::Renderer::DetachWindow ( void * aWindowId )

pure virtual

Detach a Window as a rendering surface.

Parameters

aWindowId Platform depended window handle.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ EndRender()

virtual void AeonGames::Renderer::EndRender ( void * aWindowId )

pure virtual

Ends the current render pass for the given window surface.

Parameters

aWindowId Platform dependent window handle.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ GetFrustum()

virtual const Frustum & AeonGames::Renderer::GetFrustum ( void * aWindowId ) const

pure virtual

Returns the view frustum for the given window surface.

Parameters

aWindowId Platform dependent window handle.

Returns: A const reference to the current view frustum.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ LoadMaterial()

virtual void AeonGames::Renderer::LoadMaterial ( const Material & aMaterial )

pure virtual

Loads material data into the renderer.

Parameters

aMaterial The material to load.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ LoadMesh()

virtual void AeonGames::Renderer::LoadMesh ( const Mesh & aMesh )

pure virtual

Loads mesh data into GPU memory.

Parameters

aMesh The mesh to load.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ LoadPipeline()

virtual void AeonGames::Renderer::LoadPipeline ( const Pipeline & aPipeline )

pure virtual

Loads a rendering pipeline (shaders and state) into the renderer.

Parameters

aPipeline The pipeline to load.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ LoadTexture()

virtual void AeonGames::Renderer::LoadTexture ( const Texture & aTexture )

pure virtual

Loads a texture into GPU memory.

Parameters

aTexture The texture to load.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ Render()

virtual void AeonGames::Renderer::Render	(	void *	aWindowId,
		const Matrix4x4 &	aModelMatrix,
		const Mesh &	aMesh,
		const Pipeline &	aPipeline,
		const Material *	aMaterial = nullptr,
		const BufferAccessor *	aSkeleton = nullptr,
		Topology	aTopology = Topology::TRIANGLE_LIST,
		uint32_t	aVertexStart = 0,
		uint32_t	aVertexCount = 0xffffffff,
		uint32_t	aInstanceCount = 1,
		uint32_t	aFirstInstance = 0 ) const

pure virtual

Issues a draw call for a mesh with the given pipeline and optional material.

Parameters

aWindowId	Platform dependent window handle.
aModelMatrix	Model transformation matrix.
aMesh	Mesh to render.
aPipeline	Pipeline (shaders/state) to use.
aMaterial	Optional material to bind.
aSkeleton	Optional skeleton buffer for skinned meshes.
aTopology	Primitive topology (default: TRIANGLE_LIST).
aVertexStart	First vertex index.
aVertexCount	Number of vertices to draw (default: all).
aInstanceCount	Number of instances to draw.
aFirstInstance	Index of the first instance.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ ResizeViewport()

virtual void AeonGames::Renderer::ResizeViewport	(	void *	aWindowId,
		int32_t	aX,
		int32_t	aY,
		uint32_t	aWidth,
		uint32_t	aHeight )

pure virtual

Resizes the specific window surface's viewport.

Parameters

aWindowId	Platform dependent window handle.
aX	X coordinate of the viewport.
aY	Y coordinate of the viewport.
aWidth	Width of the viewport.
aHeight	Height of the viewport.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ SetClearColor()

virtual void AeonGames::Renderer::SetClearColor	(	void *	aWindowId,
		float	R,
		float	G,
		float	B,
		float	A )

pure virtual

Sets the color to be used to clear the window background.

Parameters

aWindowId	Platform depended window handle.
R	Red component of the clear color.
G	Green component of the clear color.
B	Blue component of the clear color.
A	Alpha component of the clear color.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ SetProjectionMatrix()

virtual void AeonGames::Renderer::SetProjectionMatrix	(	void *	aWindowId,
		const Matrix4x4 &	aMatrix )

pure virtual

Sets the projection matrix for a specific window surface.

Parameters

aWindowId	Platform depended window handle.
aMatrix	The projection matrix.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ SetViewMatrix()

virtual void AeonGames::Renderer::SetViewMatrix	(	void *	aWindowId,
		const Matrix4x4 &	aMatrix )

pure virtual

Sets the view matrix for a specific window surface.

Parameters

aWindowId	Platform depended window handle.
aMatrix	The view matrix.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ UnloadMaterial()

virtual void AeonGames::Renderer::UnloadMaterial ( const Material & aMaterial )

pure virtual

Unloads material data from the renderer.

Parameters

aMaterial The material to unload.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ UnloadMesh()

virtual void AeonGames::Renderer::UnloadMesh ( const Mesh & aMesh )

pure virtual

Unloads mesh data from GPU memory.

Parameters

aMesh The mesh to unload.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ UnloadPipeline()

virtual void AeonGames::Renderer::UnloadPipeline ( const Pipeline & aPipeline )

pure virtual

Unloads a rendering pipeline from the renderer.

Parameters

aPipeline The pipeline to unload.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

◆ UnloadTexture()

virtual void AeonGames::Renderer::UnloadTexture ( const Texture & aTexture )

pure virtual

Unloads a texture from GPU memory.

Parameters

aTexture The texture to unload.

Implemented in AeonGames::OpenGLRenderer, and AeonGames::VulkanRenderer.

The documentation for this class was generated from the following files:

include/aeongames/Renderer.hpp
engine/core/Renderer.cpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ AllocateSingleFrameUniformMemory()

◆ AttachWindow()

◆ BeginRender()

◆ DetachWindow()

◆ EndRender()

◆ GetFrustum()

◆ LoadMaterial()

◆ LoadMesh()

◆ LoadPipeline()

◆ LoadTexture()

◆ Render()

◆ ResizeViewport()

◆ SetClearColor()

◆ SetProjectionMatrix()

◆ SetViewMatrix()

◆ UnloadMaterial()

◆ UnloadMesh()

◆ UnloadPipeline()

◆ UnloadTexture()