Operator Reference

render_scene_3dT_render_scene_3dRenderScene3dRenderScene3drender_scene_3d (Operator)

render_scene_3dT_render_scene_3dRenderScene3dRenderScene3drender_scene_3d — Render an image of a 3D scene.

Signature

render_scene_3d( : Image : Scene3D, CameraIndex : )

Herror T_render_scene_3d(Hobject* Image, const Htuple Scene3D, const Htuple CameraIndex)

void RenderScene3d(HObject* Image, const HTuple& Scene3D, const HTuple& CameraIndex)

HImage HScene3D::RenderScene3d(Hlong CameraIndex) const

static void HOperatorSet.RenderScene3d(out HObject image, HTuple scene3D, HTuple cameraIndex)

HImage HScene3D.RenderScene3d(int cameraIndex)

def render_scene_3d(scene_3d: HHandle, camera_index: int) -> HObject

Description

render_scene_3drender_scene_3dRenderScene3dRenderScene3drender_scene_3d renders an image of the 3D scene Scene3DScene3DScene3Dscene3Dscene_3d and returns the result in ImageImageImageimageimage. The view of the camera CameraIndexCameraIndexCameraIndexcameraIndexcamera_index is used to render the image.

The set_scene_3d_paramset_scene_3d_paramSetScene3dParamSetScene3dParamset_scene_3d_param parameters 'object_index_persistence'"object_index_persistence""object_index_persistence""object_index_persistence""object_index_persistence" and 'disp_background'"disp_background""disp_background""disp_background""disp_background" are ignored. The background of ImageImageImageimageimage is black.

render_scene_3drender_scene_3dRenderScene3dRenderScene3drender_scene_3d requires OpenGL 2.1, GLSL 1.2, and the OpenGL extensions GL_EXT_framebuffer_object and GL_EXT_framebuffer_blit. Otherwise the compatibility mode is automatically enabled. The compatibility mode requires OpenGL 1.1.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

ImageImageImageimageimage (output_object)  (multichannel-)image objectHImageHObjectHObjectHobject * (byte)

Rendered 3D scene.

Scene3DScene3DScene3Dscene3Dscene_3d (input_control)  scene_3d HScene3D, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the 3D scene.

CameraIndexCameraIndexCameraIndexcameraIndexcamera_index (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Index of the camera used to display the scene.

Result

render_scene_3drender_scene_3dRenderScene3dRenderScene3drender_scene_3d returns 2 ( H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

Alternatives

display_scene_3ddisplay_scene_3dDisplayScene3dDisplayScene3ddisplay_scene_3d

See also

create_scene_3dcreate_scene_3dCreateScene3dCreateScene3dcreate_scene_3d

Module

3D Metrology