TextureAttrib

from panda3d.core import TextureAttrib

class TextureAttrib

Bases:

Bases: RenderAttrib

Indicates the set of TextureStages and their associated Textures that should be applied to (or removed from) a node.

Inheritance diagram

add_off_stage(stage: TextureStage, override: int) → RenderAttrib: Returns a new TextureAttrib, just like this one, but with the indicated stage added to the list of stages turned off by this attrib.

add_on_stage(stage: TextureStage, tex: Texture, sampler: SamplerState, override: int) → RenderAttrib: Returns a new TextureAttrib, just like this one, but with the indicated stage added to the list of stages turned on by this attrib.

add_on_stage(stage: TextureStage, tex: Texture, override: int) → RenderAttrib: Returns a new TextureAttrib, just like this one, but with the indicated stage added to the list of stages turned on by this attrib.

property class_slot → int

find_on_stage(stage: TextureStage) → int: Returns the index number of the indicated TextureStage within the list of on_stages, or -1 if the indicated stage is not listed.

static get_class_slot() → int

static get_class_type() → TypeHandle

get_ff_tc_index(n: int) → int: For each TextureStage listed in get_on_ff_stage(), this returns a unique index number for the texture coordinate name used by that TextureStage. It is guaranteed to remain the same index number for each texcoord name (for a given set of TextureStages), even if the texture render order changes.

get_num_off_stages() → int: Returns the number of stages that are turned off by the attribute.

get_num_on_ff_stages() → int: Returns the number of on-stages that are relevant to the classic fixed function pipeline. This excludes texture stages such as normal maps.

get_num_on_stages() → int: Returns the number of stages that are turned on by the attribute.

get_off_stage(n: int) → TextureStage: Returns the nth stage turned off by the attribute, sorted in arbitrary (pointer) order.

get_off_stages() → list

get_on_ff_stage(n: int) → TextureStage: Returns the nth stage turned on by the attribute, sorted in render order, including only those relevant to the classic fixed function pipeline. This excludes texture stages such as normal maps.

get_on_ff_stages() → list

get_on_sampler(stage: TextureStage) → SamplerState: Returns the sampler associated with the indicated stage, or the one associated with its texture if no custom stage has been specified. It is an error to call this if the stage does not exist.

get_on_stage(n: int) → TextureStage: Returns the nth stage turned on by the attribute, sorted in render order.

get_on_stage_override(stage: TextureStage) → int: Returns the override value associated with the indicated stage.

get_on_stages() → list

get_on_texture(stage: TextureStage) → Texture: Returns the texture associated with the indicated stage, or NULL if no texture is associated.

get_texture() → Texture: If the TextureAttrib is not an ‘off’ TextureAttrib, returns the base-level texture that is associated. Otherwise, return NULL.

has_all_off() → bool: Returns true if this attrib turns off all stages (although it may also turn some on).

has_off_stage(stage: TextureStage) → bool: Returns true if the indicated stage is turned off by the attrib, false otherwise.

has_on_stage(stage: TextureStage) → bool: Returns true if the indicated stage is turned on by the attrib, false otherwise.

is_identity() → bool: Returns true if this is an identity attrib: it does not change the set of stages in use.

is_off() → bool

Returns true if the TextureAttrib is an ‘off’ TextureAttrib, indicating that it should disable texturing.

If multitexture is in effect, a TextureAttrib may not be strictly “on” or “off”; therefore, to get a more precise answer to this question, you should consider using has_all_off() or get_num_off_stages() or has_off_stage() instead.

static make() → RenderAttrib: The following methods define the new multitexture mode for TextureAttrib. Each TextureAttrib can add or remove individual texture stages from the complete set of textures that are to be applied; this is similar to the mechanism of LightAttrib.

static make(tex: Texture) → RenderAttrib: Constructs a new TextureAttrib object suitable for rendering the indicated texture onto geometry, using the default TextureStage.

static make_all_off() → RenderAttrib: Constructs a new TextureAttrib object that turns off all stages (and hence disables texturing).

static make_default() → RenderAttrib: Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be.

static make_off() → RenderAttrib: Constructs a new TextureAttrib object suitable for rendering untextured geometry.

property off_stages → Sequence[TextureStage]: Returns the nth stage turned off by the attribute, sorted in arbitrary (pointer) order.

property on_stages → Sequence[TextureStage]: Returns the nth stage turned on by the attribute, sorted in render order.

remove_off_stage(stage: TextureStage) → RenderAttrib: Returns a new TextureAttrib, just like this one, but with the indicated stage removed from the list of stages turned off by this attrib.

remove_on_stage(stage: TextureStage) → RenderAttrib: Returns a new TextureAttrib, just like this one, but with the indicated stage removed from the list of stages turned on by this attrib.

replace_texture(tex: Texture, new_tex: Texture) → RenderAttrib: Returns a new TextureAttrib, just like this one, but with all references to the given texture replaced with the new texture.

New in version 1.10.4.

property samplers → SamplerState: Returns the sampler associated with the indicated stage, or the one associated with its texture if no custom stage has been specified. It is an error to call this if the stage does not exist.

property textures → Texture: Returns the texture associated with the indicated stage, or NULL if no texture is associated.

unify_texture_stages(stage: TextureStage) → RenderAttrib: Returns a new TextureAttrib, just like this one, but with any included TextureAttribs that happen to have the same name as the given object replaced with the object.