Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
StencilAttrib Class Reference

A StencilAttrib is a collection of all stencil render states. More...

Inheritance diagram for StencilAttrib:
RenderAttrib TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Types

enum  StencilComparisonFunction {
  SCF_never = 1, SCF_less_than = 2, SCF_equal = 3, SCF_less_than_or_equal = 4,
  SCF_greater_than = 5, SCF_not_equal = 6, SCF_greater_than_or_equal = 7, SCF_always = 8
}
 
enum  StencilOperation {
  SO_keep = 0, SO_zero = 1, SO_replace = 2, SO_increment = 3,
  SO_decrement = 4, SO_invert = 5, SO_increment_saturate = 6, SO_decrement_saturate = 7
}
 
enum  StencilRenderState {
  SRS_front_comparison_function = 0, SRS_front_stencil_fail_operation = 1, SRS_front_stencil_pass_z_fail_operation = 2, SRS_front_stencil_pass_z_pass_operation = 3,
  SRS_reference = 4, SRS_read_mask = 5, SRS_write_mask = 6, SRS_back_comparison_function = 7,
  SRS_back_stencil_fail_operation = 8, SRS_back_stencil_pass_z_fail_operation = 9, SRS_back_stencil_pass_z_pass_operation = 10, SRS_clear = 11,
  SRS_clear_value = 12, SRS_total = 13
}
 
- Public Types inherited from RenderAttrib
enum  PandaCompareFunc {
  M_none = 0, M_never = 1, M_less = 2, M_equal = 3,
  M_less_equal = 4, M_greater = 5, M_not_equal = 6, M_greater_equal = 7,
  M_always = 8
}
 
enum  TexGenMode {
  M_off = 0, M_eye_sphere_map = 1, M_world_cube_map = 2, M_eye_cube_map = 3,
  M_world_normal = 4, M_eye_normal = 5, M_world_position = 6, M_unused = 7,
  M_eye_position = 8, M_point_sprite = 9, M_unused2 = 10, M_constant = 11
}
 

Public Member Functions

unsigned int getRenderState (StencilAttrib::StencilRenderState render_state_identifier)
 Returns render state. More...
 
- Public Member Functions inherited from RenderAttrib
int compareTo (const RenderAttrib other)
 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. More...
 
const RenderAttrib compose (const RenderAttrib other)
 Returns a new RenderAttrib object that represents the composition of this attrib with the other attrib. More...
 
int getHash ()
 Returns a suitable hash value for phash_map. More...
 
int getSlot ()
 
const RenderAttrib getUnique ()
 Returns the pointer to the unique RenderAttrib in the cache that is equivalent to this one. More...
 
const RenderAttrib invertCompose (const RenderAttrib other)
 Returns a new RenderAttrib object that represents the composition of the inverse of this attrib with the other attrib. More...
 
bool lowerAttribCanOverride ()
 Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact. More...
 
 output (Ostream out)
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static int getClassSlot ()
 
static TypeHandle getClassType ()
 
static const RenderAttrib make (bool front_enable, RenderAttrib::PandaCompareFunc front_comparison_function, StencilAttrib::StencilOperation stencil_fail_operation, StencilAttrib::StencilOperation stencil_pass_z_fail_operation, StencilAttrib::StencilOperation front_stencil_pass_z_pass_operation, unsigned int reference, unsigned int read_mask, unsigned int write_mask)
 Constructs a front face StencilAttrib. More...
 
static const RenderAttrib make2Sided (bool front_enable, bool back_enable, RenderAttrib::PandaCompareFunc front_comparison_function, StencilAttrib::StencilOperation stencil_fail_operation, StencilAttrib::StencilOperation stencil_pass_z_fail_operation, StencilAttrib::StencilOperation front_stencil_pass_z_pass_operation, unsigned int reference, unsigned int read_mask, unsigned int write_mask, RenderAttrib::PandaCompareFunc back_comparison_function, StencilAttrib::StencilOperation back_stencil_fail_operation, StencilAttrib::StencilOperation back_stencil_pass_z_fail_operation, StencilAttrib::StencilOperation back_stencil_pass_z_pass_operation)
 Constructs a two-sided StencilAttrib. More...
 
static const RenderAttrib make2SidedWithClear (bool front_enable, bool back_enable, RenderAttrib::PandaCompareFunc front_comparison_function, StencilAttrib::StencilOperation stencil_fail_operation, StencilAttrib::StencilOperation stencil_pass_z_fail_operation, StencilAttrib::StencilOperation front_stencil_pass_z_pass_operation, unsigned int reference, unsigned int read_mask, unsigned int write_mask, RenderAttrib::PandaCompareFunc back_comparison_function, StencilAttrib::StencilOperation back_stencil_fail_operation, StencilAttrib::StencilOperation back_stencil_pass_z_fail_operation, StencilAttrib::StencilOperation back_stencil_pass_z_pass_operation, bool clear, unsigned int clear_value)
 Constructs a two-sided StencilAttrib. More...
 
static const RenderAttrib makeDefault ()
 Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be. More...
 
static const RenderAttrib makeOff ()
 Constructs a StencilAttrib that has stenciling turned off. More...
 
static const RenderAttrib makeWithClear (bool front_enable, RenderAttrib::PandaCompareFunc front_comparison_function, StencilAttrib::StencilOperation stencil_fail_operation, StencilAttrib::StencilOperation stencil_pass_z_fail_operation, StencilAttrib::StencilOperation front_stencil_pass_z_pass_operation, unsigned int reference, unsigned int read_mask, unsigned int write_mask, bool clear, unsigned int clear_value)
 Constructs a front face StencilAttrib. More...
 
- Static Public Member Functions inherited from RenderAttrib
static int garbageCollect ()
 Performs a garbage-collection cycle. More...
 
static TypeHandle getClassType ()
 
static int getNumAttribs ()
 Returns the total number of unique RenderAttrib objects allocated in the world. More...
 
static listAttribs (Ostream out)
 Lists all of the RenderAttribs in the cache to the output stream, one per line. More...
 
static bool validateAttribs ()
 Ensures that the cache is still stored in sorted order. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Public Attributes

int class_slot
 
- Public Attributes inherited from RenderAttrib
int slot
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

Detailed Description

A StencilAttrib is a collection of all stencil render states.

The render states in a StencilAttrib are read-only. A StencilAttrib is created with make or make_2_sided. To determine if two sided stencil is supported, call the function GraphicsStateGuardian:: get_supports_two_sided_stencil.

Member Enumeration Documentation

◆ StencilComparisonFunction

Enumerator
SCF_never 
SCF_less_than 
SCF_equal 
SCF_less_than_or_equal 
SCF_greater_than 
SCF_not_equal 
SCF_greater_than_or_equal 
SCF_always 

◆ StencilOperation

Enumerator
SO_keep 
SO_zero 
SO_replace 
SO_increment 
SO_decrement 
SO_invert 
SO_increment_saturate 
SO_decrement_saturate 

◆ StencilRenderState

Enumerator
SRS_front_comparison_function 
SRS_front_stencil_fail_operation 
SRS_front_stencil_pass_z_fail_operation 
SRS_front_stencil_pass_z_pass_operation 
SRS_reference 
SRS_read_mask 
SRS_write_mask 
SRS_back_comparison_function 
SRS_back_stencil_fail_operation 
SRS_back_stencil_pass_z_fail_operation 
SRS_back_stencil_pass_z_pass_operation 
SRS_clear 
SRS_clear_value 
SRS_total 

Member Function Documentation

◆ getClassSlot()

static int getClassSlot ( )
static

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getRenderState()

unsigned int getRenderState ( StencilAttrib::StencilRenderState  render_state_identifier)

Returns render state.

◆ make()

static const RenderAttrib make ( bool  front_enable,
RenderAttrib::PandaCompareFunc  front_comparison_function,
StencilAttrib::StencilOperation  stencil_fail_operation,
StencilAttrib::StencilOperation  stencil_pass_z_fail_operation,
StencilAttrib::StencilOperation  front_stencil_pass_z_pass_operation,
unsigned int  reference,
unsigned int  read_mask,
unsigned int  write_mask 
)
static

Constructs a front face StencilAttrib.

◆ make2Sided()

static const RenderAttrib make2Sided ( bool  front_enable,
bool  back_enable,
RenderAttrib::PandaCompareFunc  front_comparison_function,
StencilAttrib::StencilOperation  stencil_fail_operation,
StencilAttrib::StencilOperation  stencil_pass_z_fail_operation,
StencilAttrib::StencilOperation  front_stencil_pass_z_pass_operation,
unsigned int  reference,
unsigned int  read_mask,
unsigned int  write_mask,
RenderAttrib::PandaCompareFunc  back_comparison_function,
StencilAttrib::StencilOperation  back_stencil_fail_operation,
StencilAttrib::StencilOperation  back_stencil_pass_z_fail_operation,
StencilAttrib::StencilOperation  back_stencil_pass_z_pass_operation 
)
static

Constructs a two-sided StencilAttrib.

◆ make2SidedWithClear()

static const RenderAttrib make2SidedWithClear ( bool  front_enable,
bool  back_enable,
RenderAttrib::PandaCompareFunc  front_comparison_function,
StencilAttrib::StencilOperation  stencil_fail_operation,
StencilAttrib::StencilOperation  stencil_pass_z_fail_operation,
StencilAttrib::StencilOperation  front_stencil_pass_z_pass_operation,
unsigned int  reference,
unsigned int  read_mask,
unsigned int  write_mask,
RenderAttrib::PandaCompareFunc  back_comparison_function,
StencilAttrib::StencilOperation  back_stencil_fail_operation,
StencilAttrib::StencilOperation  back_stencil_pass_z_fail_operation,
StencilAttrib::StencilOperation  back_stencil_pass_z_pass_operation,
bool  clear,
unsigned int  clear_value 
)
static

Constructs a two-sided StencilAttrib.

◆ makeDefault()

static const RenderAttrib makeDefault ( )
static

Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be.

◆ makeOff()

static const RenderAttrib makeOff ( )
static

Constructs a StencilAttrib that has stenciling turned off.

◆ makeWithClear()

static const RenderAttrib makeWithClear ( bool  front_enable,
RenderAttrib::PandaCompareFunc  front_comparison_function,
StencilAttrib::StencilOperation  stencil_fail_operation,
StencilAttrib::StencilOperation  stencil_pass_z_fail_operation,
StencilAttrib::StencilOperation  front_stencil_pass_z_pass_operation,
unsigned int  reference,
unsigned int  read_mask,
unsigned int  write_mask,
bool  clear,
unsigned int  clear_value 
)
static

Constructs a front face StencilAttrib.

Member Data Documentation

◆ class_slot

int class_slot