OpenMayaRender.MStateManager Class Reference

Inheritance diagram for OpenMayaRender.MStateManager:

Public Member Functions
def	__init__ ()
def	getBlendState ()
def	getDepthStencilState ()
def	getRasterizerState ()
def	getSamplerState ()
def	setBlendState ()
def	setDepthStencilState ()
def	setRasterizerState ()
def	setSamplerState ()

Static Public Member Functions
def	__new__ ()
def	acquireBlendState ()
def	acquireDepthStencilState ()
def	acquireRasterizerState ()
def	acquireSamplerState ()
def	getMaxSamplerCount ()
def	releaseBlendState ()
def	releaseDepthStencilState ()
def	releaseRasterizerState ()
def	releaseSamplerState ()

Static Public Attributes
int	kCompareAlways = 8
int	kCompareEqual = 3
int	kCompareGreater = 5
int	kCompareGreaterEqual = 7
int	kCompareLess = 2
int	kCompareLessEqual = 4
int	kCompareNever = 1
int	kCompareNotEqual = 6
int	kDomainShader = 5
int	kGeometryShader = 2
int	kHullShader = 4
int	kNoShader = 0
int	kPixelShader = 3
int	kVertexShader = 1

Detailed Description

Class to allow efficient access to GPU state information.

Constructor & Destructor Documentation

def OpenMayaRender.MStateManager.__init__

(

)

Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMayaRender.MStateManager.__new__ ( )

static

Create and return a new object.  See help(type) for accurate signature.

def OpenMayaRender.MStateManager.acquireBlendState ( )

static

acquireBlendState(MBlendStateDesc) -> MBlendState

Acquires an immutable unique blend state matching the blend state descriptor.

def OpenMayaRender.MStateManager.acquireDepthStencilState ( )

static

acquireDepthStencilState(MDepthStencilStateDesc) -> MDepthStencilState

Acquires an immutable unique depth-stencil state matching the blend state descriptor.

def OpenMayaRender.MStateManager.acquireRasterizerState ( )

static

acquireRasterizerState(MRasterizerStateDesc) -> MRasterizerState

Acquires an immutable unique rasterizer state matching the rasterizer state descriptor.

def OpenMayaRender.MStateManager.acquireSamplerState ( )

static

acquireSamplerState(MSamplerStateDesc) -> MSamplerState

Acquires an immutable unique sampler state matching the blend state descriptor.

def OpenMayaRender.MStateManager.getBlendState

(

)

getBlendState() -> MBlendState

Gets the current active blend state from the device.

def OpenMayaRender.MStateManager.getDepthStencilState

(

)

getDepthStencilState() -> MDepthStencilState

Gets the current depth-stencil blend state from the device.

def OpenMayaRender.MStateManager.getMaxSamplerCount ( )

static

getMaxSamplerCount() -> int

Get the maximum number of simulataneous texture coordinate interpolation channels.

def OpenMayaRender.MStateManager.getRasterizerState

(

)

getRasterizerState() -> MRasterizerState

Gets the current active rasterizer state from the device.

def OpenMayaRender.MStateManager.getSamplerState

(

)

getSamplerState(shader, samplerIndex) -> MSamplerState

Gets the current active sampler state from the device.
* shader (ShaderType) - The shader this sampler will apply to.
* samplerIndex (int) - The index of the sampler to set with the given shader state.

def OpenMayaRender.MStateManager.releaseBlendState ( )

static

releaseBlendState(MBlendState) -> None

Deletes the MBlendState and releases the reference to the underlying state object which is held by the MBlendState object.

def OpenMayaRender.MStateManager.releaseDepthStencilState ( )

static

releaseDepthStencilState(MDepthStencilState) -> None

Deletes the MDepthStencilState and releases the reference to the underlying state object which is held by the MDepthStencilState object.

def OpenMayaRender.MStateManager.releaseRasterizerState ( )

static

releaseRasterizerState(MRasterizerState) -> None

Deletes the MRasterizerState and releases the reference to the underlying state object which is held by the MRasterizerState object.

def OpenMayaRender.MStateManager.releaseSamplerState ( )

static

releaseSamplerState(MSamplerState) -> None

Deletes the MSamplerState and releases the reference to the underlying state object which is held by the MSamplerState object.

def OpenMayaRender.MStateManager.setBlendState

(

)

setBlendState(MBlendState) -> self

Sets the active blend state on the device.

def OpenMayaRender.MStateManager.setDepthStencilState

(

)

setDepthStencilState(MDepthStencilState) -> self

Sets the active depth-stencil state on the device.

def OpenMayaRender.MStateManager.setRasterizerState

(

)

setRasterizerState(MRasterizerState) -> self

Sets the active rasterizer state on the device.

def OpenMayaRender.MStateManager.setSamplerState

(

)

setSamplerState(shader, samplerIndex, samplerState) -> self

Sets the active sampler state for any of the texture samplers on the device.
* shader (ShaderType) - The shader this sampler will apply to, e.g. kPixelShader.
* samplerIndex (int) - The index of the sampler to set with the given shader state.
* samplerState (MSamplerState) - The sampler state container object that was previously acquired.