OpenGLSceneView#

class omni.kit.scene_view.opengl.OpenGLSceneView#

Bases: SceneView

OpenGLSceneView: An omni.ui.scene.SceneView implementation that will draw the scene with OpenGL.

Methods

__init__(self, model, ...)

OpenGLSceneView: An omni.ui.scene.SceneView implementation that will draw the scene with OpenGL.

get_current_textures(self, color, depth)

Get an object that represents the current color and depth textures in use.

import_texture(self, texture)

Import an external GPU reference (such as RTX renderer output) into the OpenGL context.

texture_blit(self, color, depth, scale)

Blit an external GPU reference (such as RTX renderer output) into the color or depth attachment.

Attributes

clip_mode

color_format

depth_format

__init__(
self: omni.kit.scene_view.opengl._opengl_sceneview.OpenGLSceneView,
model: omni.ui_scene._scene.AbstractManipulatorModel = None,
order_independent_transparency: bool = False,
clip_mode: omni.kit.scene_view.opengl._opengl_sceneview.ClipMode = <ClipMode.NEGATIVE_ONE_TO_ONE: 1>,
**kwargs,
) → None#

OpenGLSceneView: An omni.ui.scene.SceneView implementation that will draw the scene with OpenGL.

get_current_textures(
self: omni.kit.scene_view.opengl._opengl_sceneview.OpenGLSceneView,
color: bool = True,
depth: bool = True,
) → Dict[str, omni::ui::OpenGLTextureHandle]#

Get an object that represents the current color and depth textures in use.

Parameters:

  • color (bool) – Whether to put a reference to the color texture in the return value.

  • depth (bool) – Whether to put a reference to the depth texture in the return value

Returns:

A dcitionary with optional ‘color’ and ‘depth’ keys based on arguments.

import_texture(
self: omni.kit.scene_view.opengl._opengl_sceneview.OpenGLSceneView,
texture: omni.gpu_foundation_factory._gpu_foundation_factory.RpResource,
) → omni::ui::OpenGLTextureHandle#

Import an external GPU reference (such as RTX renderer output) into the OpenGL context.

Parameters:

texture (omni.gpu_foundation_factory._gpu_foundation_factory.RpResource) – The GPU resource to import

texture_blit(
self: omni.kit.scene_view.opengl._opengl_sceneview.OpenGLSceneView,
color: omni::ui::OpenGLTextureHandle = None,
depth: omni::ui::OpenGLTextureHandle = None,
scale: carb._carb.Float3 = carb.Float3(1,
1,
1),
) → None#

Blit an external GPU reference (such as RTX renderer output) into the color or depth attachment.

Parameters:

  • color (omni.gpu_foundation_factory._gpu_foundation_factory.RpResource) – = None The object to blit into the color attachment (or None)

  • depth (omni.gpu_foundation_factory._gpu_foundation_factory.RpResource) – = None The object to blit into the depth attachment (or None)

  • scale (carb.Float3) – = (1.0, 1.0, 1.0) The scaling factor to blit with.