openCLInfo

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

Synopsis

openCLInfo([limitMinimumVerts=boolean], [minVertexBuffer=int], [supportsDoublePrecision=boolean], [valid=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

openCLInfo 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
limitMinimumVerts(lmv)	boolean
Specifies whether the limit on the minimum vert count of the geometry is used or not. The system configuration determines a certain minimum size for geometries to be allowed on GPU. When this flag is on this limit is obeyed. When this flag is off this limit is ignored. This is only used for debugging purposes and is not saved to the file or any preferences.
minVertexBuffer(mvb)	int
Set the minimum vert count under which the geometry will not be allowed on the GPU (unless in a network with qualifying geometries). This is only used for debugging purposes and is not saved to the file or any preferences.
supportsDoublePrecision(dbl)	boolean
Specifies whether double precision can be used in OpenCL. If the platform can not allow double precision this can not be set to "on".
valid(v)	boolean
Valid in query mode only. Checks if OpenCL is initialized.

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 have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# Query if OpenCL is initialized or not
cmds.openCLInfo(query=True, valid=True)
# Result: True #

# Set the minimum vertex buffer size
cmds.openCLInfo(mvb=2000)

# Query the minimum vertex buffer size
cmds.openCLInfo(query=True, mvb=True)
# Result: 2000 #

# Query whether double precision is supported or not
cmds.openCLInfo(query=True, dbl=True)
# Result: True #