StencilAttrib

from acron.core import StencilAttrib

class StencilAttrib

Bases:

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

digraph inheritance7924abebb1 { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; "ReferenceCount" [URL="acron.core.ReferenceCount.html#acron.core.ReferenceCount",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "ReferenceCount" [arrowsize=0.75,style=""]; "RenderAttrib" [URL="acron.core.RenderAttrib.html#acron.core.RenderAttrib",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedWritableReferenceCount" -> "RenderAttrib" [arrowsize=0.75,style=""]; "StencilAttrib" [URL="acron.core.StencilAttrib.html#acron.core.StencilAttrib",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "RenderAttrib" -> "StencilAttrib" [arrowsize=0.75,style=""]; "TypedObject" [URL="acron.core.TypedObject.html#acron.core.TypedObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "TypedObject" [arrowsize=0.75,style=""]; "TypedWritable" [URL="acron.core.TypedWritable.html#acron.core.TypedWritable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedObject" -> "TypedWritable" [arrowsize=0.75,style=""]; "TypedWritableReferenceCount" [URL="acron.core.TypedWritableReferenceCount.html#acron.core.TypedWritableReferenceCount",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedWritable" -> "TypedWritableReferenceCount" [arrowsize=0.75,style=""]; "ReferenceCount" -> "TypedWritableReferenceCount" [arrowsize=0.75,style=""]; }

enum StencilComparisonFunction

Exists purely for backward compatibility.

enumerator SCF_never = 1

enumerator SCF_less_than = 2

enumerator SCF_equal = 3

enumerator SCF_less_than_or_equal = 4

enumerator SCF_greater_than = 5

enumerator SCF_not_equal = 6

enumerator SCF_greater_than_or_equal = 7

enumerator SCF_always = 8

enum StencilOperation

enumerator SO_keep = 0

enumerator SO_zero = 1

enumerator SO_replace = 2

enumerator SO_increment = 3

enumerator SO_decrement = 4

enumerator SO_invert = 5

enumerator SO_increment_saturate = 6

enumerator SO_decrement_saturate = 7

enum StencilRenderState

enums are duplicated here from class StencilRenderStates for use in Python

enumerator SRS_front_comparison_function = 0

enumerator SRS_front_stencil_fail_operation = 1

enumerator SRS_front_stencil_pass_z_fail_operation = 2

enumerator SRS_front_stencil_pass_z_pass_operation = 3

enumerator SRS_reference = 4

enumerator SRS_read_mask = 5

enumerator SRS_write_mask = 6

enumerator SRS_back_comparison_function = 7

enumerator SRS_back_stencil_fail_operation = 8

enumerator SRS_back_stencil_pass_z_fail_operation = 9

enumerator SRS_back_stencil_pass_z_pass_operation = 10

enumerator SRS_clear = 11

enumerator SRS_clear_value = 12

enumerator SRS_total = 13

property class_slot → int

static get_class_slot()

static get_class_type()

get_render_state()

Returns render state.

static make()

Constructs a front face StencilAttrib.

static make_2_sided()

Constructs a two-sided StencilAttrib.

static make_2_sided_with_clear()

Constructs a two-sided StencilAttrib.

static make_default()

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

static make_off()

Constructs a StencilAttrib that has stenciling turned off.

static make_with_clear()

Constructs a front face StencilAttrib.