Go to: Synopsis. Return value. Keywords. Flags. MEL examples.

Synopsis

ogs [-deviceInformation] [-disposeReleasableTextures] [-dumpTexture string] [-enableHardwareInstancing boolean] [-fragmentEditor string] [-fragmentXML string] [-gpuMemoryUsed] [-pause] [-rebakeTextures] [-regenerateUVTilePreview string] [-reloadTextures] [-reset] [-shaderSource string] [-toggleTexturePaging] [-traceRenderPipeline boolean]

ogs is NOT undoable, queryable, and NOT editable.

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.

Return value

string

In query mode, return type is based on queried flag.

Keywords

ogs, debug

Flags

deviceInformation, disposeReleasableTextures, dumpTexture, enableHardwareInstancing, fragmentEditor, fragmentXML, gpuMemoryUsed, pause, rebakeTextures, regenerateUVTilePreview, reloadTextures, reset, shaderSource, toggleTexturePaging, traceRenderPipeline
Long name (short name) Argument types Properties
-deviceInformation(-di) create
If used then output the current device information.
-disposeReleasableTextures(-drt) create
Clear up all the releasable file textures that are not required for rendering.
-dumpTexture(-dt) string create
If used then dump texture memory usage info (in MB), must be used with FLAG gpuMemoryUsed. The final info detail is specified by the string parameter. Current available values are: "full" , "total".
-enableHardwareInstancing(-hwi) boolean create
Enables/disables new gpu instancing of instanceable render items in OGS.
-fragmentEditor(-fe) string create
If used then launch the fragment editor UI.
-fragmentXML(-xml) string create
Get the fragment XML associated with a shading node.
-gpuMemoryUsed(-gpu) create
If used then output the estimated amount of GPU memory in use (in MB).
-pause(-p) createquery
Toggle pausing VP2 display update
-rebakeTextures(-rbt) create
If used then re-bake all baked textures for OGS.
-regenerateUVTilePreview(-rup) string create
If used then regenerate all UV tiles preview textures for OGS.
-reloadTextures(-rlt) create
If used then reload all textures for OGS.
-reset(-r) createquery
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.
-shaderSource(-ss) string query
Get the shader source for the specified material.
-toggleTexturePaging(-ttp) create
If used then toggle the default OGS Texture paging mechanism.
-traceRenderPipeline(-trp) boolean create
Enable debug tracing of the renderer pipeline.
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

// Reset the database for all panels running the OGS renderer.
// Returns the list of panels affected.  If no panels are running the
// OGS renderer, stop OGS from listening to DG changes.
ogs -reset
// Result: modelPanel1 //