System Commands

 

Table Of Contents

 

Overview

The plugin adds hscript commands that can be used from the textport window or from scripts. There are commands to add proxy nodes, add and remove camera and objects spare parameters to the selected nodes, get and set the GPUs enable state, open the IPR window or open the options panel.

 

 

The Redshift_setGPU command, that makes possible configure the GPUs enable state in the system, only can be used before the first render. If used after render any image or after open the IPR window, the changes will not take effect.

 

The commands to control the IPR are:


Rendering from the command line

The plugin is compatible with all the Houdini non-GUI command line tools. Using these tools it is easy support external render controllers, like Deadline, or write custom batch rendering scripts. The Redshift commands are also available for these tools to make possible configure settings like the GPUs to be used in the render session.

 

This is an example of how to render a scene from the command line using the hython tool. The Redshift_setGPU hscript command is used to disable the first GPU in a four GPU system before render the scene.

hython E:\Projects\Redshift\RedshiftTest01.hip
hou.hscript("Redshift_setGPU -s 0111")
rnode = hou.node("/out/Redshift_ROP1")
rnode.render()

 

Redshift HScript Commands

Redshift_CanUseRedshiftHR
Redshift_CanUseRedshiftRT
Redshift_IPRRenderingState
Redshift_IPRRewireRootMaterialNode
Redshift_IPRUpdateSelectedObjects
Redshift_IPRUpdateState
Redshift_IPRupdateSubnetMaterials
Redshift_RVBucketRendering
Redshift_RVCopyRenderRegion
Redshift_RVRefresh
Redshift_RVRender
Redshift_RVStartStop
Redshift_about
Redshift_activatedRIQtWindow
Redshift_activatedRVQtWindow
Redshift_addProxy
Redshift_addUSDProcedural
Redshift_cameraspareparameters
Redshift_closeRIQtWindow
Redshift_closeRVQtWindow
Redshift_deactivatedRIQtWindow
Redshift_deactivatedRVQtWindow
Redshift_disableRaiseExceptionOnRenderError
Redshift_exportRenderOptionsDSFile
Redshift_getDefaultOcioDisplayForSolaris
Redshift_getDefaultOcioViewForSolaris
Redshift_getDefaultRenderingOcioColorSpaceForSolaris
Redshift_getGPUs
Redshift_getOcioColorSpacesForSolaris
Redshift_getOcioDisplaysForSolaris
Redshift_getOcioViewsForSolaris
Redshift_getProxyDependencies
Redshift_getProxyElements
Redshift_getProxyMaterials
Redshift_getProxyMaterialsList
Redshift_getRIQtPointer
Redshift_getRVQtPointer
Redshift_getRenderingOcioColorSpacesForSolaris
Redshift_initRIQtWindow
Redshift_initRVQtWindow
Redshift_objectSpareParameters
Redshift_openIPR
Redshift_openRenderInfo
Redshift_openRenderView
Redshift_openRenderViewIPR
Redshift_openViewportIPR
Redshift_openViewportRenderingIPR
Redshift_optionspanel
Redshift_reloadIPR
Redshift_removeCameraSpareParameters
Redshift_removeObjectSpareParameters
Redshift_setAlembicSopOptions
Redshift_setGPU
Redshift_setHybridRendering
Redshift_setLogLevel
Redshift_snapshotIPR
Redshift_switchConsoleLog
Redshift_updateCamerasSpareParameters
Redshift_updateIPR
Redshift_updateSpareParameters
Redshift_version