StencilAttrib

from panda3d.core import StencilAttrib

class StencilAttrib

Bases: RenderAttrib

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.

Inheritance diagram

SCFAlways = 8

SCFEqual = 3

SCFGreaterThan = 5

SCFGreaterThanOrEqual = 7

SCFLessThan = 2

SCFLessThanOrEqual = 4

SCFNever = 1

SCFNotEqual = 6

SCF_always = 8

SCF_equal = 3

SCF_greater_than = 5

SCF_greater_than_or_equal = 7

SCF_less_than = 2

SCF_less_than_or_equal = 4

SCF_never = 1

SCF_not_equal = 6

SODecrement = 4

SODecrementSaturate = 7

SOIncrement = 3

SOIncrementSaturate = 6

SOInvert = 5

SOKeep = 0

SOReplace = 2

SOZero = 1

SO_decrement = 4

SO_decrement_saturate = 7

SO_increment = 3

SO_increment_saturate = 6

SO_invert = 5

SO_keep = 0

SO_replace = 2

SO_zero = 1

SRSBackComparisonFunction = 7

SRSBackStencilFailOperation = 8

SRSBackStencilPassZFailOperation = 9

SRSBackStencilPassZPassOperation = 10

SRSClear = 11

SRSClearValue = 12

SRSFrontComparisonFunction = 0

SRSFrontStencilFailOperation = 1

SRSFrontStencilPassZFailOperation = 2

SRSFrontStencilPassZPassOperation = 3

SRSReadMask = 5

SRSReference = 4

SRSTotal = 13

SRSWriteMask = 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_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_read_mask = 5

SRS_reference = 4

SRS_total = 13

SRS_write_mask = 6

__init__(*args, **kwargs)

class_slot = 26

getClassSlot(): C++ Interface: get_class_slot()

getClassType(): C++ Interface: get_class_type()

getRenderState()

C++ Interface: get_render_state(StencilAttrib self, int render_state_identifier)

/**

Returns render state.

*/

get_class_slot(): C++ Interface: get_class_slot()

get_class_type(): C++ Interface: get_class_type()

get_render_state()

C++ Interface: get_render_state(StencilAttrib self, int render_state_identifier)

/**

Returns render state.

*/

make()

C++ Interface: make(bool front_enable, int front_comparison_function, int stencil_fail_operation, int stencil_pass_z_fail_operation, int front_stencil_pass_z_pass_operation, int reference, int read_mask, int write_mask)

/**

Constructs a front face StencilAttrib.

*/

make2Sided()

C++ Interface: make_2_sided(bool front_enable, bool back_enable, int front_comparison_function, int stencil_fail_operation, int stencil_pass_z_fail_operation, int front_stencil_pass_z_pass_operation, int reference, int read_mask, int write_mask, int back_comparison_function, int back_stencil_fail_operation, int back_stencil_pass_z_fail_operation, int back_stencil_pass_z_pass_operation)

/**

Constructs a two-sided StencilAttrib.

*/

make2SidedWithClear()

C++ Interface: make_2_sided_with_clear(bool front_enable, bool back_enable, int front_comparison_function, int stencil_fail_operation, int stencil_pass_z_fail_operation, int front_stencil_pass_z_pass_operation, int reference, int read_mask, int write_mask, int back_comparison_function, int back_stencil_fail_operation, int back_stencil_pass_z_fail_operation, int back_stencil_pass_z_pass_operation, bool clear, int clear_value)

/**

Constructs a two-sided StencilAttrib.

*/

makeDefault()

C++ Interface: make_default()

/**

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

*/

makeOff()

C++ Interface: make_off()

/**

Constructs a StencilAttrib that has stenciling turned off.

*/

makeWithClear()

C++ Interface: make_with_clear(bool front_enable, int front_comparison_function, int stencil_fail_operation, int stencil_pass_z_fail_operation, int front_stencil_pass_z_pass_operation, int reference, int read_mask, int write_mask, bool clear, int clear_value)

/**

Constructs a front face StencilAttrib.

*/

make_2_sided()

C++ Interface: make_2_sided(bool front_enable, bool back_enable, int front_comparison_function, int stencil_fail_operation, int stencil_pass_z_fail_operation, int front_stencil_pass_z_pass_operation, int reference, int read_mask, int write_mask, int back_comparison_function, int back_stencil_fail_operation, int back_stencil_pass_z_fail_operation, int back_stencil_pass_z_pass_operation)

/**

Constructs a two-sided StencilAttrib.

*/

make_2_sided_with_clear()

C++ Interface: make_2_sided_with_clear(bool front_enable, bool back_enable, int front_comparison_function, int stencil_fail_operation, int stencil_pass_z_fail_operation, int front_stencil_pass_z_pass_operation, int reference, int read_mask, int write_mask, int back_comparison_function, int back_stencil_fail_operation, int back_stencil_pass_z_fail_operation, int back_stencil_pass_z_pass_operation, bool clear, int clear_value)

/**

Constructs a two-sided StencilAttrib.

*/

make_default()

C++ Interface: make_default()

/**

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

*/

make_off()

C++ Interface: make_off()

/**

Constructs a StencilAttrib that has stenciling turned off.

*/

make_with_clear()

C++ Interface: make_with_clear(bool front_enable, int front_comparison_function, int stencil_fail_operation, int stencil_pass_z_fail_operation, int front_stencil_pass_z_pass_operation, int reference, int read_mask, int write_mask, bool clear, int clear_value)

/**

Constructs a front face StencilAttrib.

*/