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

A class object for storing a pointer to a Texture along with a set of properties that indicates which image to bind to a shader input. More...

Inheritance diagram for ParamTextureImage:
ParamValueBase TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Member Functions

 __init__ (Texture tex, bool read, bool write, int z, int n)
 Creates a new ParamTextureImage storing the given texture and image binding parameters. More...
 
int getBindLayer ()
 Returns the image layer that should be bound. More...
 
bool getBindLayered ()
 Returns true if all layers of this image should be bound simultaneously. More...
 
int getBindLevel ()
 Returns the image level that should be bound. More...
 
Texture getTexture ()
 Retrieves the texture stored in the parameter. More...
 
bool hasReadAccess ()
 Returns true if this image should be bound with read access enabled. More...
 
bool hasWriteAccess ()
 Returns true if this image should be bound with write access enabled. More...
 
- Public Member Functions inherited from ParamValueBase
TypeHandle getValueType ()
 Returns the type of the underlying value. More...
 
 output (Ostream out)
 
- 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 TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ParamValueBase
static TypeHandle getClassType ()
 
- 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 bind_layer
 Returns the image layer that should be bound. More...
 
int bind_level
 Returns the image level that should be bound. More...
 
bool read_access
 Returns true if this image should be bound with read access enabled. More...
 
Texture texture
 Retrieves the texture stored in the parameter. More...
 
bool write_access
 Returns true if this image should be bound with write access enabled. More...
 
- 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 class object for storing a pointer to a Texture along with a set of properties that indicates which image to bind to a shader input.

This class is useful for binding texture images to a shader, which is a fairly esoteric feature.

Member Function Documentation

◆ __init__()

__init__ ( Texture  tex,
bool  read,
bool  write,
int  z,
int  n 
)

Creates a new ParamTextureImage storing the given texture and image binding parameters.

◆ getBindLayer()

int getBindLayer ( )

Returns the image layer that should be bound.

This is undefined if get_bind_layered() returns false.

◆ getBindLayered()

bool getBindLayered ( )

Returns true if all layers of this image should be bound simultaneously.

◆ getBindLevel()

int getBindLevel ( )

Returns the image level that should be bound.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getTexture()

Texture getTexture ( )

Retrieves the texture stored in the parameter.

◆ hasReadAccess()

bool hasReadAccess ( )

Returns true if this image should be bound with read access enabled.

◆ hasWriteAccess()

bool hasWriteAccess ( )

Returns true if this image should be bound with write access enabled.

Member Data Documentation

◆ bind_layer

int bind_layer

Returns the image layer that should be bound.

This is undefined if get_bind_layered() returns false.

◆ bind_level

int bind_level

Returns the image level that should be bound.

◆ read_access

bool read_access

Returns true if this image should be bound with read access enabled.

◆ texture

Texture texture

Retrieves the texture stored in the parameter.

◆ write_access

bool write_access

Returns true if this image should be bound with write access enabled.