Open Inventor Release 2024.2.0
 
Loading...
Searching...
No Matches
RemoteViz::Rendering::RenderAreaHardware Class Reference

RemoteViz More...

#include <RemoteViz/Rendering/RenderAreaHardware.h>

Public Member Functions

 RenderAreaHardware ()
 Constructor.
 
 RenderAreaHardware (const RenderAreaHardware &obj)
 Copy constructor.
 
RenderAreaHardwareoperator= (const RenderAreaHardware &obj)
 Copy assignment operator.
 
 ~RenderAreaHardware ()
 Destructor.
 
void setGpu (const std::string &value)
 Sets the Graphics Processing Unit (GPU) used for rendering.
 

Detailed Description

RemoteViz

Settings to setup hardware for a render area.

If the application explicitly creates the RenderArea, an instance of this class must be passed to Service::createRenderArea.

If the RenderArea is automatically created by RemoteViz, an instance of this class will be passed to the ServiceListener::onPendingCreateRenderArea method and can be used to modify settings (for example which GPU to use for rendering).

Definition at line 55 of file RenderAreaHardware.h.

Constructor & Destructor Documentation

◆ RenderAreaHardware() [1/2]

RemoteViz::Rendering::RenderAreaHardware::RenderAreaHardware ( )

Constructor.

◆ RenderAreaHardware() [2/2]

RemoteViz::Rendering::RenderAreaHardware::RenderAreaHardware ( const RenderAreaHardware obj)

Copy constructor.

◆ ~RenderAreaHardware()

RemoteViz::Rendering::RenderAreaHardware::~RenderAreaHardware ( )

Destructor.

Member Function Documentation

◆ operator=()

RenderAreaHardware & RemoteViz::Rendering::RenderAreaHardware::operator= ( const RenderAreaHardware obj)

Copy assignment operator.

◆ setGpu()

void RemoteViz::Rendering::RenderAreaHardware::setGpu ( const std::string &  value)

Sets the Graphics Processing Unit (GPU) used for rendering.

This value can be retrieved using RenderArea::getGpu.

On X11 Linux, the default value is the value of the environment variable DISPLAY, typically ":0.0". The specification for a specific GPU depends on the X11 configuration file, but usually the first digit is the GPU index.

On Headless EGL Linux, the default value is EGL_DEFAULT_DISPLAY, typically "0". The parameter is a GPU index (0..N) (see eglQueryDevicesEXT and eglGetPlatformDisplayEXT).

Limitations:

  • Currently this feature only works on Linux.
    Calling this method on Windows is allowed, but has no effect.
  • This feature only works with the modes ServiceSettings::INVENTOR_SERVICE and ServiceSettings::INVENTOR_APPLICATION.
  • Currently this feature can only specify the GPU to be used for rendering.
    GPU accelerated video encoding, for example H.264, is always done on the GPU with id "0".
Parameters
value: GPU used to compute the render.

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