Gazebo Gazebo

API Reference

6.16.0

Rendering thread. More...

#include <Scene3D.hh>

Public Slots

void RenderNext (RenderSync *renderSync)
 Render the next frame. More...
 
void ShutDown ()
 Shutdown the thread and the render engine. More...
 
void SizeChanged ()
 Slot called to update render texture size. More...
 

Signals

void TextureReady (uint _id, const QSize &_size)
 Signal to indicate that a frame has been rendered and ready to be displayed. More...
 

Public Member Functions

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

Public Attributes

QOpenGLContext * context = nullptr
 OpenGL context to be passed to the render engine. More...
 
std::function< void(const QString &)> errorCb
 Function to be called if there are errors. More...
 
IgnRenderer ignRenderer
 Ign-rendering renderer. More...
 
QOffscreenSurface * surface = nullptr
 Offscreen surface to render to. More...
 

Detailed Description

Rendering thread.

Constructor & Destructor Documentation

◆ RenderThread()

Constructor.

Member Function Documentation

◆ RenderNext

void RenderNext ( RenderSync *  renderSync)
slot

Render the next frame.

Parameters
[in]_renderSyncRenderSync to safely synchronize Qt and worker thread (this)

◆ SetErrorCb()

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

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

Parameters
[in]_cbError callback

◆ ShutDown

void ShutDown ( )
slot

Shutdown the thread and the render engine.

◆ SizeChanged

void SizeChanged ( )
slot

Slot called to update render texture size.

◆ TextureReady

void TextureReady ( uint  _id,
const QSize &  _size 
)
signal

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

Parameters
[in]_idGLuid of the opengl texture
[in]_sizeSize of the texture

Member Data Documentation

◆ context

QOpenGLContext* context = nullptr

OpenGL context to be passed to the render engine.

◆ errorCb

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

Function to be called if there are errors.

◆ ignRenderer

IgnRenderer ignRenderer

Ign-rendering renderer.

◆ surface

QOffscreenSurface* surface = nullptr

Offscreen surface to render to.


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