Python API 2.0 Reference: OpenMayaRender.MClearOperation Class Reference

+ Inheritance diagram for OpenMayaRender.MClearOperation:

Public Member Functions

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

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
-   __builtin__.object

Constructor & Destructor Documentation

OpenMayaRender.MClearOperation.__init__ ( )
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Member Function Documentation

OpenMayaRender.MClearOperation.clearColor ( )
clearColor() -> [float, float, float, float]

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

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

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

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

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

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

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

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

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

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

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

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

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

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