Rendering thread. More...

#include <MinimalScene.hh>

Public Slots
void	RenderNext (plugins::RenderSync *_renderSync)
	Render when safe.

void	ShutDown ()
	Shutdown the thread and the render engine.

void	SizeChanged ()
	Slot called to update render texture size.

Signals
void	TextureReady (void *_texturePtr, const QSize &_size)
	Signal to indicate that a frame has been rendered and ready to be displayed.

Public Member Functions
	RenderThread ()
	Constructor.

QOpenGLContext *	Context () const
	OpenGL context to be passed to the render engine.

std::string	Initialize ()
	Carry out initialisation. On macOS this must be run on the main thread.

void	SetContext (QOpenGLContext *_context)
	Set the OpenGL context to be passed to the render engine.

void	SetErrorCb (std::function< void(const QString &)> _cb)
	Set a callback to be called in case there are errors.

void	SetGraphicsAPI (const rendering::GraphicsAPI &_graphicsAPI)
	Set the graphics API.

void	SetSurface (QOffscreenSurface *_surface)
	Set the offscreen surface to render to.

QOffscreenSurface *	Surface () const
	Offscreen surface to render to.

Public Member Functions inherited from QThread
	QThread (QObject *parent)

	~QThread ()

void	exit (int returnCode)

void	finished ()

bool	finished () const

bool	isFinished () const

bool	isRunning () const

Priority	priority () const

void	quit ()

bool	running () const

void	setPriority (Priority priority)

void	setStackSize (uint stackSize)

uint	stackSize () const

void	start (Priority priority)

void	started ()

void	terminate ()

void	terminated ()

bool	wait (unsigned long time)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method)

bool	disconnect (const QObject receiver, const char method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Attributes
std::function< void(const QString &)>	errorCb
	Function to be called if there are errors.

GzRenderer	gzRenderer
	gz-rendering renderer

Additional Inherited Members
Static Public Member Functions inherited from QThread
QThread *	currentThread ()

Qt::HANDLE	currentThreadId ()

int	idealThreadCount ()

void	yieldCurrentThread ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QThread
int	exec ()

virtual void	run ()

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QThread
void	msleep (unsigned long msecs)

void	setTerminationEnabled (bool enabled)

void	sleep (unsigned long secs)

void	usleep (unsigned long usecs)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

Rendering thread.

Constructor & Destructor Documentation

◆ RenderThread()

RenderThread ( )

Constructor.

Member Function Documentation

◆ Context()

QOpenGLContext * Context ( ) const

OpenGL context to be passed to the render engine.

◆ Initialize()

std::string Initialize ( )

Carry out initialisation. On macOS this must be run on the main thread.

◆ RenderNext

void RenderNext ( plugins::RenderSync * _renderSync )

slot

Render when safe.

Parameters

[in] _renderSync RenderSync to safely synchronize Qt and worker thread (this)

◆ SetContext()

void SetContext ( QOpenGLContext * _context )

Set the OpenGL context to be passed to the render engine.

Parameters

[in] _context OpenGL context

◆ SetErrorCb()

void SetErrorCb ( std::function< void(const QString &)> _cb )

Set a callback to be called in case there are errors.

Parameters

[in] _cb Error callback

◆ SetGraphicsAPI()

void SetGraphicsAPI ( const rendering::GraphicsAPI & _graphicsAPI )

Set the graphics API.

Parameters

[in] _graphicsAPI The type of graphics API

◆ SetSurface()

void SetSurface ( QOffscreenSurface * _surface )

Set the offscreen surface to render to.

Parameters

[in] _surface Off-screen surface format

◆ ShutDown

void ShutDown ( )

slot

Shutdown the thread and the render engine.

◆ SizeChanged

void SizeChanged ( )

slot

Slot called to update render texture size.

◆ Surface()

QOffscreenSurface * Surface ( ) const

Offscreen surface to render to.

◆ TextureReady

void TextureReady	(	void *	_texturePtr,
		const QSize &	_size
	)

signal

Signal to indicate that a frame has been rendered and ready to be displayed.

Parameters

[in]	_texturePtr	Pointer to a texture Id
[in]	_size	Size of the texture

Member Data Documentation

◆ errorCb

std::function<void(const QString &)> errorCb

Function to be called if there are errors.

◆ gzRenderer

GzRenderer gzRenderer

gz-rendering renderer

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

MinimalScene.hh

Gazebo Gui

API Reference

Public Slots

Signals

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RenderThread()

Member Function Documentation

◆ Context()

◆ Initialize()

◆ RenderNext

◆ SetContext()

◆ SetErrorCb()

◆ SetGraphicsAPI()

◆ SetSurface()

◆ ShutDown

◆ SizeChanged

◆ Surface()

◆ TextureReady

Member Data Documentation

◆ errorCb

◆ gzRenderer