Ignition Gazebo

API Reference

7.0.0~pre1

Texture node for displaying the render texture from ign-renderer. More...

#include <Scene3D.hh>

Public Slots

void NewTexture (uint _id, const QSize &_size)
 This function gets called on the FBO rendering thread and will store the texture id and size and schedule an update on the window. More...
 
void PrepareNode ()
 Before the scene graph starts to render, we update to the pending texture. More...
 

Signals

void PendingNewTexture ()
 Signal emitted when a new texture is ready to trigger window update. More...
 
void TextureInUse (RenderSync *_renderSync)
 Signal emitted when the texture is being rendered and renderer can start rendering next frame. More...
 

Public Member Functions

 TextureNode (QQuickWindow *_window, RenderSync &_renderSync)
 Constructor. More...
 
 ~TextureNode () override
 Destructor. More...
 

Public Attributes

uint id = 0
 OpenGL texture id. More...
 
QMutex mutex
 Mutex to protect the texture variables. More...
 
RenderSync & renderSync
 See RenderSync. More...
 
QSize size = QSize(0, 0)
 Texture size. More...
 
QSGTexture * texture = nullptr
 Qt's scene graph texture. More...
 
QQuickWindow * window = nullptr
 Qt quick window. More...
 

Detailed Description

Texture node for displaying the render texture from ign-renderer.

Constructor & Destructor Documentation

◆ TextureNode()

TextureNode ( QQuickWindow *  _window,
RenderSync &  _renderSync 
)
explicit

Constructor.

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

◆ ~TextureNode()

~TextureNode ( )
override

Destructor.

Member Function Documentation

◆ NewTexture

void NewTexture ( uint  _id,
const QSize &  _size 
)
slot

This function gets called on the FBO rendering thread and will store the texture id and size and schedule an update on the window.

Parameters
[in]_idOpenGL render texture Id
[in]_sizeTexture size

◆ PendingNewTexture

void PendingNewTexture ( )
signal

Signal emitted when a new texture is ready to trigger window update.

◆ PrepareNode

void PrepareNode ( )
slot

Before the scene graph starts to render, we update to the pending texture.

◆ TextureInUse

void TextureInUse ( RenderSync *  _renderSync)
signal

Signal emitted when the texture is being rendered and renderer can start rendering next frame.

Parameters
[in]_renderSyncRenderSync to send to the worker thread

Member Data Documentation

◆ id

uint id = 0

OpenGL texture id.

◆ mutex

QMutex mutex

Mutex to protect the texture variables.

◆ renderSync

RenderSync& renderSync

See RenderSync.

◆ size

QSize size = QSize(0, 0)

Texture size.

◆ texture

QSGTexture* texture = nullptr

Qt's scene graph texture.

◆ window

QQuickWindow* window = nullptr

Qt quick window.


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