# ShaderExpansion

from pandac.PandaModules import ShaderExpansion

Class : ShaderExpansion
Summary: A shader can contain context-sensitive macros. A ShaderExpansion is the output you get when you run the macro preprocessor on a shader. The ShaderExpansion contains the shader's macroexpanded text, and a map of ShaderContext objects.

## Inheritance:

ShaderExpansion: TypedReferenceCount
TypedReferenceCount: TypedObject ReferenceCount
TypedObject:
ReferenceCount:

## Methods of ShaderExpansion:

getClassType
getName
getText
make
parseEof
parseInit
parseLine
parseLineno
parseRest
parseUpto
prepare
release
releaseAll

## Methods of TypedReferenceCount:

getClassType

## Methods of TypedObject:

getBestParentFromSet
getClassType
getType
getTypeIndex
isExactType
isOfType

## Methods of ReferenceCount:

getClassType
getRefCount
ref
testRefCountIntegrity
unref

getClassType static TypeHandle ShaderExpansion::get_class_type(void); Undocumented function.

getName string const &ShaderExpansion::get_name(void) const; Filename: shaderExpansion.I Heavily Modified: jyelon (Sep05) PANDA 3D SOFTWARE Copyright (c) 2001 - 2004, Disney Enterprises, Inc. All rights reserved All use of this software is subject to the terms of the Panda 3d Software license. You should have received a copy of this license along with this source code; you will also find a current copy of the license at http://etc.cmu.edu/panda3d/docs/license/ . To contact the maintainers of this program write to panda3d-general@lists.sourceforge.net . Description: Return the ShaderExpansion's text.

getText string const &ShaderExpansion::get_text(void) const; Description: Return the ShaderExpansion's text.

make static PointerTo< ShaderExpansion > ShaderExpansion::make(string const &name, string const &body); Description: Create a shader expansion (or reuse one from cache)

parseEof bool ShaderExpansion::parse_eof(void); Description: Returns true if the parse pointer is at the end of the shader.

parseInit void ShaderExpansion::parse_init(void); These routines help split the shader into sections, for those shader implementations that need to do so. Description: Set a 'parse pointer' to the beginning of the shader.

parseLine void ShaderExpansion::parse_line(string &result, bool rt, bool lt); These routines help split the shader into sections, for those shader implementations that need to do so. Description: Parse a line of text. If 'lt' is true, trim blanks from the left end of the line. If 'rt' is true, trim blanks from the right end (the newline is always trimmed).

parseLineno int ShaderExpansion::parse_lineno(void); Description: Returns the line number of the current parse pointer.

parseRest void ShaderExpansion::parse_rest(string &result); Description: Returns the rest of the text from the current parse location.

parseUpto void ShaderExpansion::parse_upto(string &result, string pattern, bool include); Description: Parse lines until you read a line that matches the specified pattern. Returns all the preceding lines, and if the include flag is set, returns the final line as well.

prepare void ShaderExpansion::prepare(PreparedGraphicsObjects *prepared_objects); Description: Indicates that the shader should be enqueued to be prepared in the indicated prepared_objects at the beginning of the next frame. This will ensure the texture is already loaded into texture memory if it is expected to be rendered soon. Use this function instead of prepare_now() to preload textures from a user interface standpoint.

release bool ShaderExpansion::release(PreparedGraphicsObjects *prepared_objects); Description: Frees the texture context only on the indicated object, if it exists there. Returns true if it was released, false if it had not been prepared.

releaseAll int ShaderExpansion::release_all(void); Description: Frees the context allocated on all objects for which the texture has been declared. Returns the number of contexts which have been freed.

getClassType static TypeHandle TypedReferenceCount::get_class_type(void); Undocumented function.

getBestParentFromSet int TypedObject::get_best_parent_from_Set(set< int > const &) const; Description: Returns true if the current object is the indicated type exactly.

getClassType static TypeHandle TypedObject::get_class_type(void); Undocumented function.

getType virtual TypeHandle TypedObject::get_type(void) const = 0; Derived classes should override this function to return get_class_type().

getTypeIndex int TypedObject::get_type_index(void) const; Description: Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index().

isExactType bool TypedObject::is_exact_type(TypeHandle handle) const; Description: Returns true if the current object is the indicated type exactly.

isOfType bool TypedObject::is_of_type(TypeHandle handle) const; Description: Returns true if the current object is or derives from the indicated type.

getClassType static TypeHandle ReferenceCount::get_class_type(void); Undocumented function.

getRefCount int ReferenceCount::get_ref_count(void) const; Description: Returns the current reference count.

ref void ReferenceCount::ref(void) const; Description: Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

testRefCountIntegrity bool ReferenceCount::test_ref_count_integrity(void) const; Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

unref bool ReferenceCount::unref(void) const; Description: Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete(). User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it. The return value is true if the new reference count is nonzero, false if it is zero.