pymel.core.system.ogs — PyMEL 1.0.7 documentation

pymel.core.system.ogs

ogs(*args, **kwargs)

OGS is one of the viewport renderers. As there is a lot of effort involved in migrating functionality it will evolve over several releases. As it evolves it is prudent to provide safeguards to get the database back to a known state. That is the function of this command, similar to how ‘dgdirty’ is used to restore state to the dependency graph.

Flags:

Long Name / Short Name Argument Types Properties
deviceInformation / di bool ../../../_images/create.gif
 
If used then output the current device information. Flag can have multiple arguments, passed either as a tuple or a list.
enableHardwareInstancing / hwi bool ../../../_images/create.gif
 
Enables/disables new gpu instancing of instanceable render items in OGS.
fragmentEditor / fe bool ../../../_images/create.gif
 
If used then launch the fragment editor UI.
gpuMemoryUsed / gpu bool ../../../_images/create.gif
 
If used then output the estimated amount of GPU memory in use (in MB).
rebakeTextures / rbt bool ../../../_images/create.gif
 
If used then re-bake all baked textures for OGS.
regenerateUVTilePreview / rup unicode ../../../_images/create.gif
 
If used then regenerate all UV tiles preview textures for OGS.
reloadTextures / rlt bool ../../../_images/create.gif
 
If used then reload all textures for OGS.
reset / r bool ../../../_images/create.gif ../../../_images/query.gif
 

If used then reset the entire OGS database for all viewports using it. In query mode the number of viewports that would be affected is returned but the reset is not actually done. If no viewport is using OGS then OGS will stop listening to DG changes.

Derived from mel command maya.cmds.ogs

Example:

import pymel.core as pm

// Reset the database for all panels running the OGS renderer.
// Returns the number of panels affected.
pm.ogs( reset=True )
// Result: [modelPanel1] //

Previous topic

pymel.core.system.newFile

Next topic

pymel.core.system.openFile

Core Modules

Type Modules

Other Modules

This Page