Python API 2.0 Reference
OpenMayaRender.MClearOperation Class Reference
+ Inheritance diagram for OpenMayaRender.MClearOperation:

Public Member Functions

def __init__ ()
 
def clearColor ()
 
def clearColor2 ()
 
def clearDepth ()
 
def clearGradient ()
 
def clearStencil ()
 
def mask ()
 
def overridesColors ()
 
def setClearColor ()
 
def setClearColor2 ()
 
def setClearDepth ()
 
def setClearGradient ()
 
def setClearStencil ()
 
def setMask ()
 
def setOverridesColors ()
 
- Public Member Functions inherited from OpenMayaRender.MRenderOperation
def __init__ ()
 
def enableSRGBWrite ()
 
def name ()
 
def operationType ()
 
def targetOverrideList ()
 
def viewportRectangleOverride ()
 

Static Public Member Functions

def __new__ ()
 
- Static Public Member Functions inherited from OpenMayaRender.MRenderOperation
def __new__ ()
 

Static Public Attributes

int kClearAll = -1
 
int kClearColor = 1
 
int kClearDepth = 2
 
int kClearNone = 0
 
int kClearStencil = 4
 
- Static Public Attributes inherited from OpenMayaRender.MRenderOperation
int kClear = 0
 
int kHUDRender = 4
 
int kPresentTarget = 5
 
int kQuadRender = 2
 
int kSceneRender = 1
 
int kUserDefined = 3
 

Detailed Description

Class which defines the operation of clearing render target channels.

Method resolution order:
-   MClearOperation
-   MRenderOperation
-   builtins.object

Constructor & Destructor Documentation

def OpenMayaRender.MClearOperation.__init__ ( )
Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMayaRender.MClearOperation.__new__ ( )
static
Create and return a new object.  See help(type) for accurate signature.
def OpenMayaRender.MClearOperation.clearColor ( )
clearColor() -> [float, float, float, float]

Query the first clear color values.
def OpenMayaRender.MClearOperation.clearColor2 ( )
clearColor2() -> [float, float, float, float]

Query the second clear color values.
def OpenMayaRender.MClearOperation.clearDepth ( )
clearDepth() -> float

Query the clear depth value.
def OpenMayaRender.MClearOperation.clearGradient ( )
clearGradient() -> bool

Query if the clear should clear with a vertical color gradient.
def OpenMayaRender.MClearOperation.clearStencil ( )
clearStencil() -> int

Query the stencil clear value.
def OpenMayaRender.MClearOperation.mask ( )
mask() -> int

Query the clear mask.
def OpenMayaRender.MClearOperation.overridesColors ( )
overridesColors() -> bool

Query whether clear colors are set by the override or come from Maya's preferences.
def OpenMayaRender.MClearOperation.setClearColor ( )
setClearColor([float, float, float, float]) -> self

Set the first clear color values.
def OpenMayaRender.MClearOperation.setClearColor2 ( )
setClearColor2([float, float, float, float]) -> self

Set the second clear color values.
def OpenMayaRender.MClearOperation.setClearDepth ( )
setClearDepth(float) -> self

Set the clear depth value.
def OpenMayaRender.MClearOperation.setClearGradient ( )
setClearGradient(bool) -> self

Set whether to clear with a vertical color gradient.
def OpenMayaRender.MClearOperation.setClearStencil ( )
setClearStencil(int) -> self

Set the clear stencil value.
def OpenMayaRender.MClearOperation.setMask ( )
setMask(int) -> self

Set the clear mask to define which channels to clear.
def OpenMayaRender.MClearOperation.setOverridesColors ( )
setOverridesColors(bool) -> self

Set the enabled state to control whether the clear operation overrides Maya's color preferences.