ogs

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

Synopsis

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

ogs is NOT undoable, queryable, and NOT editable.

Return value

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

Keywords

Flags

Long name (short name)	Argument types	Properties
-deviceInformation(-di)
If used then output the current device information.
-disposeReleasableTextures(-drt)
Clear up all the releasable file textures in GPU memory that are not required for rendering.
-dumpTexture(-dt)	string
If used then dump GPU 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
Enables/disables new gpu instancing of instanceable render items in OGS.
-fragmentEditor(-fe)	string
If used then launch the fragment editor UI.
-fragmentXML(-xml)	string
Get the fragment XML associated with a shading node.
-gpuMemoryTotal(-gmt)	int
Get or set the total amount of GPU memory which Maya is allowed to use (in MB).
-gpuMemoryUsed(-gpu)
If used then output the estimated amount of GPU memory in use (in MB).
-isLegacyViewportEnabled(-lve)
To query if the legacy viewport is enabled.
-isRemoteGLSessionEnabled(-rgl)
Query if remote gl is allowed
-isWinRemoteSession(-irs)
Query if this is a remote session.
-pause(-p)
Toggle pausing VP2 display update
-rebakeTextures(-rbt)
If used then re-bake all baked textures for OGS.
-regenerateUVTilePreview(-rup)	string
If used then regenerate all UV tiles preview textures for OGS.
-reloadTextures(-rlt)
If used then reload all textures for OGS.
-reset(-r)
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
Get the shader source for the specified material.
-toggleTexturePaging(-ttp)
If used then toggle the default OGS Texture paging mechanism.
-traceRenderPipeline(-trp)	boolean
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 //

// Set the gpu memory limit to 2048 MB.  Memory management systems
// will attempt to avoid going over this limit.  Can be used to reserve
// memory for other applications.
ogs -gpuMemoryTotal 2048

// Output the current gpu memory limit in MB.
ogs -q -gpuMemoryTotal
// Result: 2048 //

// Output an estimate of the amount of currently allocated gpu memory by
// Maya in MB.
ogs -gpu
// Result: 148 //