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

Defines the properties of a named stage of the multitexture pipeline. More...

#include "textureStage.h"

Inheritance diagram for TextureStage:
TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

Public Types

enum  CombineMode {
  CM_undefined, CM_replace, CM_modulate, CM_add,
  CM_add_signed, CM_interpolate, CM_subtract, CM_dot3_rgb,
  CM_dot3_rgba
}
 
enum  CombineOperand {
  CO_undefined, CO_src_color, CO_one_minus_src_color, CO_src_alpha,
  CO_one_minus_src_alpha
}
 
enum  CombineSource {
  CS_undefined, CS_texture, CS_constant, CS_primary_color,
  CS_previous, CS_constant_color_scale, CS_last_saved_result
}
 
enum  Mode {
  M_modulate, M_decal, M_blend, M_replace,
  M_add, M_combine, M_blend_color_scale, M_modulate_glow,
  M_modulate_gloss, M_normal, M_normal_height, M_glow,
  M_gloss, M_height, M_selector, M_normal_gloss
}
 

Public Member Functions

 TextureStage (const std::string &name)
 Initialize the texture stage at construction. More...
 
 TextureStage (const TextureStage &copy)
 Initialize the texture stage from other. More...
 
int compare_to (const TextureStage &other) const
 Returns a number less than zero if this TextureStage sorts before the other one, greater than zero if it sorts after, or zero if they are equivalent. More...
 
virtual int complete_pointers (TypedWritable **plist, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More...
 
virtual TypeHandle force_init_type ()
 
int get_alpha_scale () const
 
InternalNameget_binormal_name () const
 
LColor get_color () const
 
CombineMode get_combine_alpha_mode () const
 Get combine_alpha_mode. More...
 
CombineOperand get_combine_alpha_operand0 () const
 Get operand0 of combine_alpha_mode. More...
 
CombineOperand get_combine_alpha_operand1 () const
 Get operand1 of combine_alpha_mode. More...
 
CombineOperand get_combine_alpha_operand2 () const
 Get operand2 of combine_alpha_mode. More...
 
CombineSource get_combine_alpha_source0 () const
 Get source0 of combine_alpha_mode. More...
 
CombineSource get_combine_alpha_source1 () const
 Get source1 of combine_alpha_mode. More...
 
CombineSource get_combine_alpha_source2 () const
 Get source2 of combine_alpha_mode. More...
 
CombineMode get_combine_rgb_mode () const
 Get the combine_rgb_mode. More...
 
CombineOperand get_combine_rgb_operand0 () const
 Get operand0 of combine_rgb_mode. More...
 
CombineOperand get_combine_rgb_operand1 () const
 Get operand1 of combine_rgb_mode. More...
 
CombineOperand get_combine_rgb_operand2 () const
 Get operand2 of combine_rgb_mode. More...
 
CombineSource get_combine_rgb_source0 () const
 Get source0 of combine_rgb_mode. More...
 
CombineSource get_combine_rgb_source1 () const
 Get source1 of combine_rgb_mode. More...
 
CombineSource get_combine_rgb_source2 () const
 Get source2 of combine_rgb_mode. More...
 
Mode get_mode () const
 
const std::string & get_name () const
 
int get_num_combine_alpha_operands () const
 Returns the number of meaningful operands that may be retrieved via get_combine_alpha_sourceN() and get_combine_alpha_operandN(). More...
 
int get_num_combine_rgb_operands () const
 Returns the number of meaningful operands that may be retrieved via get_combine_rgb_sourceN() and get_combine_rgb_operandN(). More...
 
int get_priority () const
 
int get_rgb_scale () const
 
bool get_saved_result () const
 
int get_sort () const
 
InternalNameget_tangent_name () const
 
int get_tex_view_offset () const
 
InternalNameget_texcoord_name () const
 
virtual TypeHandle get_type () const
 
bool involves_color_scale () const
 Returns true if the TextureStage is affected by the setting of the current ColorScaleAttrib, false otherwise. More...
 
bool is_fixed_function () const
 Returns true if the TextureStage is relevant to the classic fixed function pipeline. More...
 
void mark_used_by_auto_shader () const
 Marks this TextureStage as having been used by the auto shader. More...
 
bool operator != (const TextureStage &other) const
 
bool operator< (const TextureStage &other) const
 
void operator= (const TextureStage &copy)
 just copy the members of other to this More...
 
bool operator== (const TextureStage &other) const
 
void output (std::ostream &out) const
 Just a single line output. More...
 
void set_alpha_scale (int alpha_scale)
 
void set_color (const LColor &color)
 
void set_combine_alpha (CombineMode mode, CombineSource source0, CombineOperand operand0)
 Specifies any of the CombineMode values that represent a one-parameter operation. More...
 
void set_combine_alpha (CombineMode mode, CombineSource source0, CombineOperand operand0, CombineSource source1, CombineOperand operand1)
 Specifies any of the CombineMode values that represent a two-parameter operation. More...
 
void set_combine_alpha (CombineMode mode, CombineSource source0, CombineOperand operand0, CombineSource source1, CombineOperand operand1, CombineSource source2, CombineOperand operand2)
 Specifies any of the CombineMode values that represent a one-parameter operation. More...
 
void set_combine_rgb (CombineMode mode, CombineSource source0, CombineOperand operand0)
 Specifies any of the CombineMode values that represent a one-parameter operation. More...
 
void set_combine_rgb (CombineMode mode, CombineSource source0, CombineOperand operand0, CombineSource source1, CombineOperand operand1)
 Specifies any of the CombineMode values that represent a two-parameter operation. More...
 
void set_combine_rgb (CombineMode mode, CombineSource source0, CombineOperand operand0, CombineSource source1, CombineOperand operand1, CombineSource source2, CombineOperand operand2)
 Specifies any of the CombineMode values that represent a one-parameter operation. More...
 
void set_mode (Mode mode)
 
void set_name (const std::string &name)
 
void set_priority (int priority)
 
void set_rgb_scale (int rgb_scale)
 
void set_saved_result (bool saved_result)
 
void set_sort (int sort)
 
void set_tex_view_offset (int tex_view_offset)
 
void set_texcoord_name (InternalName *name)
 
void set_texcoord_name (const std::string &texcoord_name)
 
bool uses_color () const
 Returns true if the TextureStage makes use of whatever color is specified in set_color(), false otherwise. More...
 
bool uses_last_saved_result () const
 Returns true if the TextureStage makes use of the CS_primary_color combine source. More...
 
bool uses_primary_color () const
 Returns true if the TextureStage makes use of the CS_primary_color combine source. More...
 
void write (std::ostream &out) const
 Writes the details of this stage. More...
 
virtual void write_datagram (BamWriter *manager, Datagram &me)
 Function to write the important information in the particular object to a Datagram. More...
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
vector_uchar encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
virtual void finalize (BamReader *manager)
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More...
 
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter. More...
 
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
void operator= (const TypedWritable &copy)
 
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...
 
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static TextureStageget_default ()
 
static UpdateSeq get_sort_seq ()
 Returns a global sequence number that is incremented any time any TextureStage in the world changes sort or priority. More...
 
static void init_type ()
 
static TypedWritablemake_TextureStage (const FactoryParams &params)
 Factory method to generate a TextureStage object. More...
 
static void register_with_read_factory ()
 Factory method to generate a TextureStage object. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

 get_alpha_scale
 See set_alpha_scale(). More...
 
 get_binormal_name
 Returns the set of binormals this texture stage will use. More...
 
 get_color
 return the color for this stage More...
 
 get_default
 Returns the default TextureStage that will be used for all texturing that does not name a particular stage. More...
 
 get_mode
 Return the mode of this stage. More...
 
 get_name
 Returns the name of this texture stage. More...
 
 get_priority
 Returns the priority associated with this stage. More...
 
 get_rgb_scale
 See set_rgb_scale(). More...
 
 get_saved_result
 Returns the current setting of the saved_result flag. More...
 
 get_sort
 Returns the sort order of this texture stage. More...
 
 get_tangent_name
 Returns the set of tangents this texture stage will use. More...
 
 get_tex_view_offset
 Returns the current setting of the tex_view_offset. More...
 
 get_texcoord_name
 See set_texcoord_name. More...
 
 set_alpha_scale
 Sets an additional factor that will scale the alpha component after the texture has been applied. More...
 
 set_color
 Set the color for this stage. More...
 
 set_mode
 Set the mode of this texture stage. More...
 
 set_name
 Changes the name of this texture stage. More...
 
 set_priority
 Changes the relative importance of the texture associated with this stage relative to the other texture stages that are applied simultaneously. More...
 
 set_rgb_scale
 Sets an additional factor that will scale all three r, g, b components after the texture has been applied. More...
 
 set_saved_result
 Sets the saved_result flag. More...
 
 set_sort
 Changes the order in which the texture associated with this stage is rendered relative to the other texture stages. More...
 
 set_tex_view_offset
 Sets the tex_view_offset value. More...
 
 set_texcoord_name
 Indicate which set of UV's this texture stage will use. More...
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = nullptr)
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 

Additional Inherited Members

- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

Detailed Description

Defines the properties of a named stage of the multitexture pipeline.

The TextureAttrib will associated a number of these stages with Texture objects, and the GSG will render geometry by sorting all of the currently active TextureStages in order and then issuing the appropriate rendering calls to activate them.

Definition at line 35 of file textureStage.h.

Constructor & Destructor Documentation

◆ TextureStage() [1/2]

TextureStage::TextureStage ( const std::string &  name)
explicit

Initialize the texture stage at construction.

Definition at line 30 of file textureStage.cxx.

Referenced by make_TextureStage().

◆ TextureStage() [2/2]

TextureStage::TextureStage ( const TextureStage copy)
inline

Initialize the texture stage from other.

Definition at line 18 of file textureStage.I.

Member Function Documentation

◆ compare_to()

int TextureStage::compare_to ( const TextureStage other) const

◆ complete_pointers()

int TextureStage::complete_pointers ( TypedWritable **  p_list,
BamReader manager 
)
virtual

Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

Returns the number of pointers processed.

Reimplemented from TypedWritable.

Definition at line 415 of file textureStage.cxx.

◆ get_combine_alpha_mode()

TextureStage::CombineMode TextureStage::get_combine_alpha_mode ( ) const
inline

Get combine_alpha_mode.

Definition at line 534 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_alpha_operand0()

TextureStage::CombineOperand TextureStage::get_combine_alpha_operand0 ( ) const
inline

Get operand0 of combine_alpha_mode.

Definition at line 559 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_alpha_operand1()

TextureStage::CombineOperand TextureStage::get_combine_alpha_operand1 ( ) const
inline

Get operand1 of combine_alpha_mode.

Definition at line 575 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_alpha_operand2()

TextureStage::CombineOperand TextureStage::get_combine_alpha_operand2 ( ) const
inline

Get operand2 of combine_alpha_mode.

Definition at line 591 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_alpha_source0()

TextureStage::CombineSource TextureStage::get_combine_alpha_source0 ( ) const
inline

Get source0 of combine_alpha_mode.

Definition at line 551 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_alpha_source1()

TextureStage::CombineSource TextureStage::get_combine_alpha_source1 ( ) const
inline

Get source1 of combine_alpha_mode.

Definition at line 567 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_alpha_source2()

TextureStage::CombineSource TextureStage::get_combine_alpha_source2 ( ) const
inline

Get source2 of combine_alpha_mode.

Definition at line 583 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_rgb_mode()

TextureStage::CombineMode TextureStage::get_combine_rgb_mode ( ) const
inline

Get the combine_rgb_mode.

Definition at line 396 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_rgb_operand0()

TextureStage::CombineOperand TextureStage::get_combine_rgb_operand0 ( ) const
inline

Get operand0 of combine_rgb_mode.

Definition at line 421 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_rgb_operand1()

TextureStage::CombineOperand TextureStage::get_combine_rgb_operand1 ( ) const
inline

Get operand1 of combine_rgb_mode.

Definition at line 437 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_rgb_operand2()

TextureStage::CombineOperand TextureStage::get_combine_rgb_operand2 ( ) const
inline

Get operand2 of combine_rgb_mode.

Definition at line 453 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_rgb_source0()

TextureStage::CombineSource TextureStage::get_combine_rgb_source0 ( ) const
inline

Get source0 of combine_rgb_mode.

Definition at line 413 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_rgb_source1()

TextureStage::CombineSource TextureStage::get_combine_rgb_source1 ( ) const
inline

Get source1 of combine_rgb_mode.

Definition at line 429 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_combine_rgb_source2()

TextureStage::CombineSource TextureStage::get_combine_rgb_source2 ( ) const
inline

Get source2 of combine_rgb_mode.

Definition at line 445 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_num_combine_alpha_operands()

int TextureStage::get_num_combine_alpha_operands ( ) const
inline

Returns the number of meaningful operands that may be retrieved via get_combine_alpha_sourceN() and get_combine_alpha_operandN().

Definition at line 543 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_num_combine_rgb_operands()

int TextureStage::get_num_combine_rgb_operands ( ) const
inline

Returns the number of meaningful operands that may be retrieved via get_combine_rgb_sourceN() and get_combine_rgb_operandN().

Definition at line 405 of file textureStage.I.

Referenced by compare_to(), and write().

◆ get_sort_seq()

UpdateSeq TextureStage::get_sort_seq ( )
inlinestatic

Returns a global sequence number that is incremented any time any TextureStage in the world changes sort or priority.

This is used by TextureAttrib to determine when it is necessary to re-sort its internal array of stages.

Definition at line 675 of file textureStage.I.

◆ involves_color_scale()

bool TextureStage::involves_color_scale ( ) const
inline

Returns true if the TextureStage is affected by the setting of the current ColorScaleAttrib, false otherwise.

Definition at line 600 of file textureStage.I.

◆ is_fixed_function()

bool TextureStage::is_fixed_function ( ) const
inline

Returns true if the TextureStage is relevant to the classic fixed function pipeline.

This excludes texture stages such as normal mapping and the like.

Definition at line 193 of file textureStage.I.

◆ make_TextureStage()

TypedWritable * TextureStage::make_TextureStage ( const FactoryParams params)
static

Factory method to generate a TextureStage object.

Definition at line 349 of file textureStage.cxx.

References DatagramIterator::get_bool(), get_default, parse_params(), and TextureStage().

Referenced by register_with_read_factory().

◆ mark_used_by_auto_shader()

void TextureStage::mark_used_by_auto_shader ( ) const
inline

Marks this TextureStage as having been used by the auto shader.

Definition at line 683 of file textureStage.I.

◆ operator=()

void TextureStage::operator= ( const TextureStage copy)

just copy the members of other to this

Definition at line 66 of file textureStage.cxx.

◆ output()

void TextureStage::output ( std::ostream &  out) const

Just a single line output.

Definition at line 265 of file textureStage.cxx.

References get_name.

◆ register_with_read_factory()

void TextureStage::register_with_read_factory ( )
static

Factory method to generate a TextureStage object.

Definition at line 341 of file textureStage.cxx.

References BamReader::get_factory(), make_TextureStage(), and Factory< Type >::register_factory().

◆ set_combine_alpha() [1/3]

void TextureStage::set_combine_alpha ( CombineMode  mode,
CombineSource  source0,
CombineOperand  operand0 
)
inline

Specifies any of the CombineMode values that represent a one-parameter operation.

Specifically, this is CM_replace only.

Definition at line 462 of file textureStage.I.

◆ set_combine_alpha() [2/3]

void TextureStage::set_combine_alpha ( CombineMode  mode,
CombineSource  source0,
CombineOperand  operand0,
CombineSource  source1,
CombineOperand  operand1 
)
inline

Specifies any of the CombineMode values that represent a two-parameter operation.

Specifically, this is everything except for CM_replace and CM_interpolate.

Definition at line 485 of file textureStage.I.

◆ set_combine_alpha() [3/3]

void TextureStage::set_combine_alpha ( CombineMode  mode,
CombineSource  source0,
CombineOperand  operand0,
CombineSource  source1,
CombineOperand  operand1,
CombineSource  source2,
CombineOperand  operand2 
)
inline

Specifies any of the CombineMode values that represent a one-parameter operation.

Specifically, this is CM_interpolate only.

Definition at line 509 of file textureStage.I.

◆ set_combine_rgb() [1/3]

void TextureStage::set_combine_rgb ( CombineMode  mode,
CombineSource  source0,
CombineOperand  operand0 
)
inline

Specifies any of the CombineMode values that represent a one-parameter operation.

Specifically, this is CM_replace only.

Definition at line 324 of file textureStage.I.

◆ set_combine_rgb() [2/3]

void TextureStage::set_combine_rgb ( CombineMode  mode,
CombineSource  source0,
CombineOperand  operand0,
CombineSource  source1,
CombineOperand  operand1 
)
inline

Specifies any of the CombineMode values that represent a two-parameter operation.

Specifically, this is everything except for CM_replace and CM_interpolate.

Definition at line 347 of file textureStage.I.

◆ set_combine_rgb() [3/3]

void TextureStage::set_combine_rgb ( CombineMode  mode,
CombineSource  source0,
CombineOperand  operand0,
CombineSource  source1,
CombineOperand  operand1,
CombineSource  source2,
CombineOperand  operand2 
)
inline

Specifies any of the CombineMode values that represent a one-parameter operation.

Specifically, this is CM_interpolate only.

Definition at line 371 of file textureStage.I.

◆ uses_color()

bool TextureStage::uses_color ( ) const
inline

Returns true if the TextureStage makes use of whatever color is specified in set_color(), false otherwise.

Definition at line 609 of file textureStage.I.

◆ uses_last_saved_result()

bool TextureStage::uses_last_saved_result ( ) const
inline

Returns true if the TextureStage makes use of the CS_primary_color combine source.

Definition at line 627 of file textureStage.I.

◆ uses_primary_color()

bool TextureStage::uses_primary_color ( ) const
inline

Returns true if the TextureStage makes use of the CS_primary_color combine source.

Definition at line 618 of file textureStage.I.

◆ write()

void TextureStage::write ( std::ostream &  out) const

◆ write_datagram()

void TextureStage::write_datagram ( BamWriter manager,
Datagram me 
)
virtual

Function to write the important information in the particular object to a Datagram.

Reimplemented from TypedWritable.

Definition at line 428 of file textureStage.cxx.

References Datagram::add_bool(), Datagram::add_int32(), Datagram::add_string(), Datagram::add_uint8(), get_default, BamWriter::get_file_minor_ver(), and BamWriter::write_pointer().

Member Data Documentation

◆ get_alpha_scale

int TextureStage::get_alpha_scale
inline

See set_alpha_scale().

Definition at line 200 of file textureStage.h.

Referenced by compare_to(), and write().

◆ get_binormal_name

InternalName * TextureStage::get_binormal_name
inline

Returns the set of binormals this texture stage will use.

This is the same as get_binormal_name(), except that the first part is "binormal".

Definition at line 194 of file textureStage.h.

◆ get_color

LColor TextureStage::get_color
inline

return the color for this stage

Definition at line 198 of file textureStage.h.

Referenced by write().

◆ get_default

TextureStage * TextureStage::get_default
inline

Returns the default TextureStage that will be used for all texturing that does not name a particular stage.

This generally handles the normal single-texture case.

Definition at line 205 of file textureStage.h.

Referenced by make_TextureStage(), and write_datagram().

◆ get_mode

TextureStage::Mode TextureStage::get_mode
inline

Return the mode of this stage.

Definition at line 196 of file textureStage.h.

Referenced by compare_to(), and write().

◆ get_name

const std::string & TextureStage::get_name
inline

Returns the name of this texture stage.

Definition at line 188 of file textureStage.h.

Referenced by compare_to(), output(), and write().

◆ get_priority

int TextureStage::get_priority
inline

Returns the priority associated with this stage.

This is specially helpful for cards that do not support more than n stages of multi-texturing.

Definition at line 190 of file textureStage.h.

Referenced by compare_to(), and write().

◆ get_rgb_scale

int TextureStage::get_rgb_scale
inline

See set_rgb_scale().

Definition at line 199 of file textureStage.h.

Referenced by compare_to(), and write().

◆ get_saved_result

bool TextureStage::get_saved_result
inline

Returns the current setting of the saved_result flag.

See set_saved_result().

Definition at line 201 of file textureStage.h.

Referenced by compare_to(), and write().

◆ get_sort

int TextureStage::get_sort
inline

Returns the sort order of this texture stage.

Definition at line 189 of file textureStage.h.

Referenced by compare_to(), and write().

◆ get_tangent_name

InternalName * TextureStage::get_tangent_name
inline

Returns the set of tangents this texture stage will use.

This is the same as get_texcoord_name(), except that the first part is "tangent".

Definition at line 193 of file textureStage.h.

◆ get_tex_view_offset

int TextureStage::get_tex_view_offset
inline

Returns the current setting of the tex_view_offset.

See set_tex_view_offset().

Definition at line 203 of file textureStage.h.

Referenced by compare_to(), PT(), and write().

◆ get_texcoord_name

InternalName * TextureStage::get_texcoord_name
inline

See set_texcoord_name.

The default is InternalName::get_texcoord().

Definition at line 192 of file textureStage.h.

Referenced by compare_to(), DXShaderContext9::update_shader_vertex_arrays(), and write().

◆ set_alpha_scale

void TextureStage::set_alpha_scale
inline

Sets an additional factor that will scale the alpha component after the texture has been applied.

This is used only when the mode is CM_combine.

The only legal values are 1, 2, or 4.

Definition at line 200 of file textureStage.h.

◆ set_color

void TextureStage::set_color
inline

Set the color for this stage.

Definition at line 198 of file textureStage.h.

◆ set_mode

void TextureStage::set_mode
inline

Set the mode of this texture stage.

Definition at line 196 of file textureStage.h.

◆ set_name

void TextureStage::set_name
inline

Changes the name of this texture stage.

Definition at line 188 of file textureStage.h.

◆ set_priority

void TextureStage::set_priority
inline

Changes the relative importance of the texture associated with this stage relative to the other texture stages that are applied simultaneously.

This is unrelated to set_sort(), which controls the order in which multiple textures are applied. The priority number is used to decide which of the requested textures are to be selected for rendering when more textures are requested than the hardware will support. The highest-priority n textures are selected for rendering, and then rendered in order by their sort factor.

Definition at line 190 of file textureStage.h.

◆ set_rgb_scale

void TextureStage::set_rgb_scale
inline

Sets an additional factor that will scale all three r, g, b components after the texture has been applied.

This is used only when the mode is CM_combine.

The only legal values are 1, 2, or 4.

Definition at line 199 of file textureStage.h.

◆ set_saved_result

void TextureStage::set_saved_result
inline

Sets the saved_result flag.

When this is true, the output of this stage will be supplied as the "last_saved_result" source for any future stages, until the next TextureStage with a saved_result set true is encountered.

This can be used to reuse the results of this texture stage as input to more than one stage later in the pipeline.

The last texture in the pipeline (the one with the highest sort value) should not have this flag set.

Definition at line 201 of file textureStage.h.

◆ set_sort

void TextureStage::set_sort
inline

Changes the order in which the texture associated with this stage is rendered relative to the other texture stages.

When geometry is rendered with multiple textures, the textures are rendered in order from the lowest sort number to the highest sort number.

Also see set_priority(), which is used to select the most important textures for rendering when some must be omitted because of hardware limitations.

Definition at line 189 of file textureStage.h.

◆ set_tex_view_offset

void TextureStage::set_tex_view_offset
inline

Sets the tex_view_offset value.

This is used only when a special multiview texture is bound to the TextureStage, and it selects the particular view of the texture that is to be used.

This value is added to the similar parameter on DisplayRegion to derive the final texture view index that is selected for rendering.

Definition at line 203 of file textureStage.h.

◆ set_texcoord_name

void TextureStage::set_texcoord_name
inline

Indicate which set of UV's this texture stage will use.

Geometry may have any number of associated UV sets, each of which must have a unique name.

Definition at line 192 of file textureStage.h.


The documentation for this class was generated from the following files: