#include <GPUDisplayBackend.h>

Inherited by o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

Classes
struct	DrawArraysIndirectCommand

struct	FontSymbol

Public Types
enum	drawType { POINTS = 0 , LINES = 1 , LINE_STRIP = 2 }

enum	backendTypes { TYPE_INVALID = -1 , TYPE_OPENGL = 0 , TYPE_VULKAN = 1 , TYPE_NONE = 2 }

enum	fpsLimitModes : int32_t { FPS_LIMIT_NONE = 0 , FPS_LIMIT_VSYNC = 1 , FPS_LIMIT_RATE = 2 }

typedef std::tuple< uint32_t, uint32_t, int32_t >	vboList

Public Member Functions
	GPUDisplayBackend ()

virtual	~GPUDisplayBackend ()

virtual int32_t	ExtInit ()

virtual uint32_t	drawVertices (const vboList &v, const drawType t)=0

virtual uint32_t	drawField ()

virtual void	ActivateColor (std::array< float, 4 > &color)=0

virtual void	setQuality ()

virtual void	SetVSync (bool enable)

virtual bool	canLimitToVSync () const

int32_t	fpsLimitMode () const

virtual bool	backendNeedRedraw ()

virtual void	setDepthBuffer ()=0

virtual int32_t	InitBackendA ()=0

virtual void	ExitBackendA ()=0

int32_t	InitBackend ()

void	updateFontScale (float scale)

void	ExitBackend ()

virtual void	loadDataToGPU (size_t totalVertizes)=0

virtual bool	prepareDraw (const hmm_mat4 &proj, const hmm_mat4 &view, bool requestScreenshot=false, bool toMixBuffer=false, float includeMixImage=0.f)=0

virtual void	finishDraw (bool doScreenshot, bool toMixBuffer=false, float includeMixImage=0.f)=0

virtual void	finishFrame (bool doScreenshot, bool toMixBuffer=false, float includeMixImage=0.f)=0

virtual void	prepareText ()=0

virtual void	finishText ()=0

virtual void	pointSizeFactor (float factor)=0

virtual void	lineWidthFactor (float factor)=0

backendTypes	backendType () const

const char *	backendName () const

virtual void	resizeScene (uint32_t width, uint32_t height)

virtual size_t	needMultiVBO ()

virtual void	GLPrintText (const char s, float x, float y, float color, float scale, uint32_t nCharacters)=0

virtual void	GLDrawQuad (const float(&corners)[4][2], const float *color)=0

void	GLDrawLine (float x0, float y0, float x1, float y1, float width, const float *color)

uint32_t	GLDrawConsole (float verticalFraction, std::span< const std::string > previous, const std::string &current, int32_t cursorPos, uint32_t scroll)

std::vector< char >	getPixels ()

virtual float	getYFactor () const

virtual int32_t	getMaxMSAA () const

Static Public Member Functions
static GPUDisplayBackend *	getBackend (const char *type)

Protected Member Functions
virtual void	addFontSymbol (int32_t symbol, int32_t sizex, int32_t sizey, int32_t offsetx, int32_t offsety, int32_t advance, void *data)=0

virtual void	initializeTextDrawing ()=0

virtual void	clearFontSymbols ()

void	loadFont ()

float	getDownsampleFactor (bool screenshot=false)

void	fillIndirectCmdBuffer ()

bool	smoothFont ()

Protected Attributes
GPUDisplay *	mDisplay = nullptr

std::vector< int32_t >	mIndirectSectorOffset

vecpod< DrawArraysIndirectCommand >	mCmdBuffer

bool	mFreetypeInitialized = false

float	mFontRasterScale = 1.f

float	mFontCharWidth = 0.f

std::vector< char >	mScreenshotPixels

int32_t	mDownsampleFactor = 1

uint32_t	mRenderWidth = 0

uint32_t	mRenderHeight = 0

uint32_t	mMaxRenderSize = UINT32_MAX

uint32_t	mScreenWidth = 0

uint32_t	mScreenHeight = 0

backendTypes	mBackendType = TYPE_INVALID

const char *	mBackendName = nullptr

std::unique_ptr< GPUDisplayMagneticField >	mMagneticFieldVisualization

Static Protected Attributes
static constexpr int32_t	SOLID_GLYPH = 128

static constexpr float	SMOOTH_POINT_EXTRA_SIZE = 0.6f

static constexpr float	SMOOTH_LINE_EXTRA_WIDTH = 0.8f

Detailed Description

Definition at line 35 of file GPUDisplayBackend.h.

Member Typedef Documentation

◆ vboList

typedef std::tuple<uint32_t, uint32_t, int32_t> o2::gpu::GPUDisplayBackend::vboList

Definition at line 45 of file GPUDisplayBackend.h.

Member Enumeration Documentation

◆ backendTypes

enum o2::gpu::GPUDisplayBackend::backendTypes

Enumerator
TYPE_INVALID
TYPE_OPENGL
TYPE_VULKAN
TYPE_NONE

Definition at line 53 of file GPUDisplayBackend.h.

◆ drawType

enum o2::gpu::GPUDisplayBackend::drawType

Enumerator
POINTS
LINES
LINE_STRIP

Definition at line 47 of file GPUDisplayBackend.h.

◆ fpsLimitModes

enum o2::gpu::GPUDisplayBackend::fpsLimitModes : int32_t

Enumerator
FPS_LIMIT_NONE
FPS_LIMIT_VSYNC
FPS_LIMIT_RATE

Definition at line 80 of file GPUDisplayBackend.h.

Constructor & Destructor Documentation

◆ GPUDisplayBackend()

GPUDisplayBackend::GPUDisplayBackend ( )

default

◆ ~GPUDisplayBackend()

GPUDisplayBackend::~GPUDisplayBackend ( )

virtualdefault

Member Function Documentation

◆ ActivateColor()

virtual void o2::gpu::GPUDisplayBackend::ActivateColor ( std::array< float, 4 > & color )

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ addFontSymbol()

virtual void o2::gpu::GPUDisplayBackend::addFontSymbol	(	int32_t	symbol,
		int32_t	sizex,
		int32_t	sizey,
		int32_t	offsetx,
		int32_t	offsety,
		int32_t	advance,
		void *	data
	)

protectedpure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ backendName()

const char * o2::gpu::GPUDisplayBackend::backendName ( ) const

inline

Definition at line 101 of file GPUDisplayBackend.h.

◆ backendNeedRedraw()

virtual bool o2::gpu::GPUDisplayBackend::backendNeedRedraw ( )

inlinevirtual

Reimplemented in o2::gpu::GPUDisplayBackendVulkan.

Definition at line 85 of file GPUDisplayBackend.h.

◆ backendType()

backendTypes o2::gpu::GPUDisplayBackend::backendType ( ) const

inline

Definition at line 100 of file GPUDisplayBackend.h.

◆ canLimitToVSync()

virtual bool o2::gpu::GPUDisplayBackend::canLimitToVSync ( ) const

inlinevirtual

Reimplemented in o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

Definition at line 83 of file GPUDisplayBackend.h.

◆ clearFontSymbols()

virtual void o2::gpu::GPUDisplayBackend::clearFontSymbols ( )

inlineprotectedvirtual

Reimplemented in o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

Definition at line 116 of file GPUDisplayBackend.h.

◆ drawField()

virtual uint32_t o2::gpu::GPUDisplayBackend::drawField ( )

inlinevirtual

Reimplemented in o2::gpu::GPUDisplayBackendOpenGL.

Definition at line 76 of file GPUDisplayBackend.h.

◆ drawVertices()

virtual uint32_t o2::gpu::GPUDisplayBackend::drawVertices	(	const vboList &	v,
		const drawType	t
	)

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ ExitBackend()

void GPUDisplayBackend::ExitBackend ( )

Definition at line 157 of file GPUDisplayBackend.cxx.

◆ ExitBackendA()

virtual void o2::gpu::GPUDisplayBackend::ExitBackendA ( )

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ ExtInit()

virtual int32_t o2::gpu::GPUDisplayBackend::ExtInit ( )

inlinevirtual

Reimplemented in o2::gpu::GPUDisplayBackendOpenGL.

Definition at line 43 of file GPUDisplayBackend.h.

◆ fillIndirectCmdBuffer()

void GPUDisplayBackend::fillIndirectCmdBuffer ( )

protected

Definition at line 169 of file GPUDisplayBackend.cxx.

◆ finishDraw()

virtual void o2::gpu::GPUDisplayBackend::finishDraw	(	bool	doScreenshot,
		bool	toMixBuffer = `false`,
		float	includeMixImage = `0.f`
	)

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ finishFrame()

virtual void o2::gpu::GPUDisplayBackend::finishFrame	(	bool	doScreenshot,
		bool	toMixBuffer = `false`,
		float	includeMixImage = `0.f`
	)

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ finishText()

virtual void o2::gpu::GPUDisplayBackend::finishText ( )

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ fpsLimitMode()

int32_t GPUDisplayBackend::fpsLimitMode ( ) const

Definition at line 185 of file GPUDisplayBackend.cxx.

◆ getBackend()

GPUDisplayBackend * GPUDisplayBackend::getBackend ( const char * type )

static

Definition at line 48 of file GPUDisplayBackend.cxx.

◆ getDownsampleFactor()

float GPUDisplayBackend::getDownsampleFactor ( bool screenshot = false )

protected

Definition at line 194 of file GPUDisplayBackend.cxx.

◆ getMaxMSAA()

virtual int32_t o2::gpu::GPUDisplayBackend::getMaxMSAA ( ) const

inlinevirtual

Reimplemented in o2::gpu::GPUDisplayBackendVulkan.

Definition at line 111 of file GPUDisplayBackend.h.

◆ getPixels()

std::vector< char > GPUDisplayBackend::getPixels ( )

Definition at line 162 of file GPUDisplayBackend.cxx.

◆ getYFactor()

virtual float o2::gpu::GPUDisplayBackend::getYFactor ( ) const

inlinevirtual

Reimplemented in o2::gpu::GPUDisplayBackendVulkan.

Definition at line 110 of file GPUDisplayBackend.h.

◆ GLDrawConsole()

uint32_t GPUDisplayBackend::GLDrawConsole	(	float	verticalFraction,
		std::span< const std::string >	previous,
		const std::string &	current,
		int32_t	cursorPos,
		uint32_t	scroll
	)

Definition at line 223 of file GPUDisplayBackend.cxx.

◆ GLDrawLine()

void GPUDisplayBackend::GLDrawLine	(	float	x0,
		float	y0,
		float	x1,
		float	y1,
		float	width,
		const float *	color
	)

Definition at line 213 of file GPUDisplayBackend.cxx.

◆ GLDrawQuad()

virtual void o2::gpu::GPUDisplayBackend::GLDrawQuad	(	const float(&)	corners[4][2],
		const float *	color
	)

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ GLPrintText()

virtual void o2::gpu::GPUDisplayBackend::GLPrintText	(	const char *	s,
		float	x,
		float	y,
		float *	color,
		float	scale,
		uint32_t	nCharacters
	)

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ InitBackend()

int32_t GPUDisplayBackend::InitBackend ( )

Definition at line 68 of file GPUDisplayBackend.cxx.

◆ InitBackendA()

virtual int32_t o2::gpu::GPUDisplayBackend::InitBackendA ( )

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ initializeTextDrawing()

virtual void o2::gpu::GPUDisplayBackend::initializeTextDrawing ( )

protectedpure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ lineWidthFactor()

virtual void o2::gpu::GPUDisplayBackend::lineWidthFactor ( float factor )

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ loadDataToGPU()

virtual void o2::gpu::GPUDisplayBackend::loadDataToGPU ( size_t totalVertizes )

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ loadFont()

void GPUDisplayBackend::loadFont ( )

protected

Definition at line 89 of file GPUDisplayBackend.cxx.

◆ needMultiVBO()

virtual size_t o2::gpu::GPUDisplayBackend::needMultiVBO ( )

inlinevirtual

Reimplemented in o2::gpu::GPUDisplayBackendOpenGL.

Definition at line 103 of file GPUDisplayBackend.h.

◆ pointSizeFactor()

virtual void o2::gpu::GPUDisplayBackend::pointSizeFactor ( float factor )

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ prepareDraw()

virtual bool o2::gpu::GPUDisplayBackend::prepareDraw	(	const hmm_mat4 &	proj,
		const hmm_mat4 &	view,
		bool	requestScreenshot = `false`,
		bool	toMixBuffer = `false`,
		float	includeMixImage = `0.f`
	)

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ prepareText()

virtual void o2::gpu::GPUDisplayBackend::prepareText ( )

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ resizeScene()

virtual void o2::gpu::GPUDisplayBackend::resizeScene	(	uint32_t	width,
		uint32_t	height
	)

inlinevirtual

Reimplemented in o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

Definition at line 102 of file GPUDisplayBackend.h.

◆ setDepthBuffer()

virtual void o2::gpu::GPUDisplayBackend::setDepthBuffer ( )

pure virtual

Implemented in o2::gpu::GPUDisplayBackendNone, o2::gpu::GPUDisplayBackendOpenGL, and o2::gpu::GPUDisplayBackendVulkan.

◆ setQuality()

virtual void o2::gpu::GPUDisplayBackend::setQuality ( )

inlinevirtual

Reimplemented in o2::gpu::GPUDisplayBackendOpenGL.

Definition at line 78 of file GPUDisplayBackend.h.

◆ SetVSync()

virtual void o2::gpu::GPUDisplayBackend::SetVSync ( bool enable )

inlinevirtual

Reimplemented in o2::gpu::GPUDisplayBackendVulkan.

Definition at line 79 of file GPUDisplayBackend.h.

◆ smoothFont()

bool GPUDisplayBackend::smoothFont ( )

protected

Definition at line 208 of file GPUDisplayBackend.cxx.

◆ updateFontScale()

void GPUDisplayBackend::updateFontScale ( float scale )

Definition at line 80 of file GPUDisplayBackend.cxx.

Member Data Documentation

◆ mBackendName

const char* o2::gpu::GPUDisplayBackend::mBackendName = nullptr

protected

Definition at line 143 of file GPUDisplayBackend.h.

◆ mBackendType

backendTypes o2::gpu::GPUDisplayBackend::mBackendType = TYPE_INVALID

protected

Definition at line 142 of file GPUDisplayBackend.h.

◆ mCmdBuffer

vecpod<DrawArraysIndirectCommand> o2::gpu::GPUDisplayBackend::mCmdBuffer

protected

Definition at line 125 of file GPUDisplayBackend.h.

◆ mDisplay

GPUDisplay* o2::gpu::GPUDisplayBackend::mDisplay = nullptr

protected

Definition at line 123 of file GPUDisplayBackend.h.

◆ mDownsampleFactor

int32_t o2::gpu::GPUDisplayBackend::mDownsampleFactor = 1

protected

Definition at line 134 of file GPUDisplayBackend.h.

◆ mFontCharWidth

float o2::gpu::GPUDisplayBackend::mFontCharWidth = 0.f

protected

Definition at line 129 of file GPUDisplayBackend.h.

◆ mFontRasterScale

float o2::gpu::GPUDisplayBackend::mFontRasterScale = 1.f

protected

Definition at line 127 of file GPUDisplayBackend.h.

◆ mFreetypeInitialized

bool o2::gpu::GPUDisplayBackend::mFreetypeInitialized = false

protected

Definition at line 126 of file GPUDisplayBackend.h.

◆ mIndirectSectorOffset

std::vector<int32_t> o2::gpu::GPUDisplayBackend::mIndirectSectorOffset

protected

Definition at line 124 of file GPUDisplayBackend.h.

◆ mMagneticFieldVisualization

std::unique_ptr<GPUDisplayMagneticField> o2::gpu::GPUDisplayBackend::mMagneticFieldVisualization

protected

Definition at line 145 of file GPUDisplayBackend.h.

◆ mMaxRenderSize

uint32_t o2::gpu::GPUDisplayBackend::mMaxRenderSize = UINT32_MAX

protected

Definition at line 138 of file GPUDisplayBackend.h.

◆ mRenderHeight

uint32_t o2::gpu::GPUDisplayBackend::mRenderHeight = 0

protected

Definition at line 137 of file GPUDisplayBackend.h.

◆ mRenderWidth

uint32_t o2::gpu::GPUDisplayBackend::mRenderWidth = 0

protected

Definition at line 136 of file GPUDisplayBackend.h.

◆ mScreenHeight

uint32_t o2::gpu::GPUDisplayBackend::mScreenHeight = 0

protected

Definition at line 140 of file GPUDisplayBackend.h.

◆ mScreenshotPixels

std::vector<char> o2::gpu::GPUDisplayBackend::mScreenshotPixels

protected

Definition at line 130 of file GPUDisplayBackend.h.

◆ mScreenWidth

uint32_t o2::gpu::GPUDisplayBackend::mScreenWidth = 0

protected

Definition at line 139 of file GPUDisplayBackend.h.

◆ SMOOTH_LINE_EXTRA_WIDTH

constexpr float o2::gpu::GPUDisplayBackend::SMOOTH_LINE_EXTRA_WIDTH = 0.8f

staticconstexprprotected

Definition at line 133 of file GPUDisplayBackend.h.

◆ SMOOTH_POINT_EXTRA_SIZE

constexpr float o2::gpu::GPUDisplayBackend::SMOOTH_POINT_EXTRA_SIZE = 0.6f

staticconstexprprotected

Definition at line 132 of file GPUDisplayBackend.h.

◆ SOLID_GLYPH

constexpr int32_t o2::gpu::GPUDisplayBackend::SOLID_GLYPH = 128

staticconstexprprotected

Definition at line 128 of file GPUDisplayBackend.h.

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

/home/runner/work/AliceO2/AliceO2/GPU/GPUTracking/display/backend/GPUDisplayBackend.h
/home/runner/work/AliceO2/AliceO2/GPU/GPUTracking/display/backend/GPUDisplayBackend.cxx

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ vboList

Member Enumeration Documentation

◆ backendTypes

◆ drawType

◆ fpsLimitModes

Constructor & Destructor Documentation

◆ GPUDisplayBackend()

◆ ~GPUDisplayBackend()

Member Function Documentation

◆ ActivateColor()

◆ addFontSymbol()

◆ backendName()

◆ backendNeedRedraw()

◆ backendType()

◆ canLimitToVSync()

◆ clearFontSymbols()

◆ drawField()

◆ drawVertices()

◆ ExitBackend()

◆ ExitBackendA()

◆ ExtInit()

◆ fillIndirectCmdBuffer()

◆ finishDraw()

◆ finishFrame()

◆ finishText()

◆ fpsLimitMode()

◆ getBackend()

◆ getDownsampleFactor()

◆ getMaxMSAA()

◆ getPixels()

◆ getYFactor()

◆ GLDrawConsole()

◆ GLDrawLine()

◆ GLDrawQuad()

◆ GLPrintText()

◆ InitBackend()

◆ InitBackendA()

◆ initializeTextDrawing()

◆ lineWidthFactor()

◆ loadDataToGPU()

◆ loadFont()

◆ needMultiVBO()

◆ pointSizeFactor()

◆ prepareDraw()

◆ prepareText()

◆ resizeScene()

◆ setDepthBuffer()

◆ setQuality()

◆ SetVSync()

◆ smoothFont()

◆ updateFontScale()

Member Data Documentation

◆ mBackendName

◆ mBackendType

◆ mCmdBuffer

◆ mDisplay

◆ mDownsampleFactor

◆ mFontCharWidth

◆ mFontRasterScale

◆ mFreetypeInitialized

◆ mIndirectSectorOffset

◆ mMagneticFieldVisualization

◆ mMaxRenderSize

◆ mRenderHeight

◆ mRenderWidth

◆ mScreenHeight

◆ mScreenshotPixels

◆ mScreenWidth

◆ SMOOTH_LINE_EXTRA_WIDTH

◆ SMOOTH_POINT_EXTRA_SIZE

◆ SOLID_GLYPH