# StencilAttrib

from pandac.PandaModules import StencilAttrib

Class : StencilAttrib
Description : Enables or disables writing of pixel to framebuffer based on its alpha value relative to a reference alpha value

## Inheritance:

StencilAttrib: RenderAttrib
RenderAttrib: TypedWritableReferenceCount
TypedWritableReferenceCount: TypedWritable ReferenceCount
TypedWritable: TypedObject
TypedObject:
ReferenceCount:

## Methods of StencilAttrib:

getClassType
getRenderState
make
make2Sided
makeOff

## Methods of RenderAttrib:

compareTo
getClassType
getNumAttribs
listAttribs
output
validateAttribs
write

## Methods of TypedWritableReferenceCount:

getClassType

## Methods of TypedWritable:

getClassType

## Methods of TypedObject:

getClassType
getType
getTypeIndex
isExactType
isOfType

## Methods of ReferenceCount:

getClassType
getRefCount
ref
testRefCountIntegrity
testRefCountNonzero
unref

## Constants in StencilAttrib:

SRSFrontEnable | (StencilRenderState)
SRSBackEnable | (StencilRenderState)
SRSFrontComparisonFunction | (StencilRenderState)
SRSFrontStencilFailOperation | (StencilRenderState)
SRSFrontStencilPassZFailOperation | (StencilRenderState)
SRSFrontStencilPassZPassOperation | (StencilRenderState)
SRSReference | (StencilRenderState)
SRSReadMask | (StencilRenderState)
SRSWriteMask | (StencilRenderState)
SRSBackComparisonFunction | (StencilRenderState)
SRSBackStencilFailOperation | (StencilRenderState)
SRSBackStencilPassZFailOperation | (StencilRenderState)
SRSBackStencilPassZPassOperation | (StencilRenderState)
SRSTotal | (StencilRenderState)
SRSFirst | (StencilRenderState)
SCFNever | (StencilComparisonFunction)
SCFLessThan | (StencilComparisonFunction)
SCFEqual | (StencilComparisonFunction)
SCFLessThanOrEqual | (StencilComparisonFunction)
SCFGreaterThan | (StencilComparisonFunction)
SCFNotEqual | (StencilComparisonFunction)
SCFGreaterThanOrEqual | (StencilComparisonFunction)
SCFAlways | (StencilComparisonFunction)
SOKeep | (StencilOperation)
SOZero | (StencilOperation)
SOReplace | (StencilOperation)
SOIncrement | (StencilOperation)
SODecrement | (StencilOperation)
SOInvert | (StencilOperation)
SOIncrementSaturate | (StencilOperation)
SODecrementSaturate | (StencilOperation)
SMDefault | (StencilMask)

## Constants in RenderAttrib:

MNone | (PandaCompareFunc)
MNever | (PandaCompareFunc)
MLess | (PandaCompareFunc)
MEqual | (PandaCompareFunc)
MLessEqual | (PandaCompareFunc)
MGreater | (PandaCompareFunc)
MNotEqual | (PandaCompareFunc)
MGreaterEqual | (PandaCompareFunc)
MAlways | (PandaCompareFunc)
MOff | (TexGenMode)
MEyeSphereMap | (TexGenMode)
MWorldCubeMap | (TexGenMode)
MEyeCubeMap | (TexGenMode)
MWorldNormal | (TexGenMode)
MEyeNormal | (TexGenMode)
MWorldPosition | (TexGenMode)
MUnused | (TexGenMode)
MEyePosition | (TexGenMode)
MPointSprite | (TexGenMode)
MLightVector | (TexGenMode)

getClassType static TypeHandle StencilAttrib::get_class_type(void); Undocumented function.

getRenderState unsigned int StencilAttrib::get_render_state(unsigned int render_state_identifier) const; Filename: stencilAttrib.I Created by: aignacio (18May06) PANDA 3D SOFTWARE Copyright (c) 2001 - 2006, Disney Enterprises, Inc. All rights reserved All use of this software is subject to the terms of the Panda 3d Software license. You should have received a copy of this license along with this source code; you will also find a current copy of the license at http://etc.cmu.edu/panda3d/docs/license/ . To contact the maintainers of this program write to panda3d-general@lists.sourceforge.net . Description: Returns render state.

make static ConstPointerTo< RenderAttrib > StencilAttrib::make(unsigned int front_enable, unsigned int front_comparison_function, unsigned int stencil_fail_operation, unsigned int stencil_pass_z_fail_operation, unsigned int front_stencil_pass_z_pass_operation, unsigned int reference, unsigned int read_mask, unsigned int write_mask); Description: Constructs a front face StencilAttrib.

make2Sided static ConstPointerTo< RenderAttrib > StencilAttrib::make_2_sided(unsigned int front_enable, unsigned int back_enable, unsigned int front_comparison_function, unsigned int stencil_fail_operation, unsigned int stencil_pass_z_fail_operation, unsigned int front_stencil_pass_z_pass_operation, unsigned int reference, unsigned int read_mask, unsigned int write_mask, unsigned int back_comparison_function, unsigned int back_stencil_fail_operation, unsigned int back_stencil_pass_z_fail_operation, unsigned int back_stencil_pass_z_pass_operation); Description: Constructs a two-sided StencilAttrib.

makeOff static ConstPointerTo< RenderAttrib > StencilAttrib::make_off(void); Description: Constructs a front face StencilAttrib.

compareTo int RenderAttrib::compare_to(RenderAttrib const &other) const; Description: Provides an arbitrary ordering among all unique RenderAttribs, so we can store the essentially different ones in a big set and throw away the rest. This method is not needed outside of the RenderAttrib class because all equivalent RenderAttrib objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.

getClassType static TypeHandle RenderAttrib::get_class_type(void); Undocumented function.

getNumAttribs static int RenderAttrib::get_num_attribs(void); Description: Returns the total number of unique RenderAttrib objects allocated in the world. This will go up and down during normal operations.

listAttribs static void RenderAttrib::list_attribs(ostream &out); Description: Lists all of the RenderAttribs in the cache to the output stream, one per line. This can be quite a lot of output if the cache is large, so be prepared.

output virtual void RenderAttrib::output(ostream &out) const; Description:

validateAttribs static bool RenderAttrib::validate_attribs(void); Description: Ensures that the cache is still stored in sorted order. Returns true if so, false if there is a problem (which implies someone has modified one of the supposedly-const RenderAttrib objects).

write virtual void RenderAttrib::write(ostream &out, int indent_level) const; Description:

getClassType static TypeHandle TypedWritableReferenceCount::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedWritable::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedObject::get_class_type(void); Undocumented function.

getType virtual TypeHandle TypedObject::get_type(void) const = 0; Derived classes should override this function to return get_class_type().

getTypeIndex int TypedObject::get_type_index(void) const; Description: Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index().

isExactType bool TypedObject::is_exact_type(TypeHandle handle) const; Description: Returns true if the current object is the indicated type exactly.

isOfType bool TypedObject::is_of_type(TypeHandle handle) const; Description: Returns true if the current object is or derives from the indicated type.

getClassType static TypeHandle ReferenceCount::get_class_type(void); Undocumented function.

getRefCount int ReferenceCount::get_ref_count(void) const; Description: Returns the current reference count.

ref void ReferenceCount::ref(void) const; Description: Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

testRefCountIntegrity bool ReferenceCount::test_ref_count_integrity(void) const; Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero bool ReferenceCount::test_ref_count_nonzero(void) const; Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref bool ReferenceCount::unref(void) const; Description: Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete(). User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it. The return value is true if the new reference count is nonzero, false if it is zero.