# Shader

from pandac.PandaModules import Shader

Class : Shader
Description :

## Inheritance:

Shader: TypedWritableReferenceCount
TypedWritableReferenceCount: TypedWritable ReferenceCount
TypedWritable: TypedObject
TypedObject: MemoryBase
MemoryBase:
ReferenceCount: MemoryBase

## Methods of Shader:

getBody
getClassType
getFile
getLoaded
getLoadError
getName
getPreprocessor
load
macroexpand
make

## Methods of TypedWritableReferenceCount:

getClassType

## Methods of TypedWritable:

getClassType

## Methods of TypedObject:

getClassType
getType
getTypeIndex
isExactType
isOfType

## Methods of ReferenceCount:

getClassType
getRefCount
ref
testRefCountIntegrity
testRefCountNonzero
unref

getBody string const &Shader::get_body(void) const; Description:

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

getFile Filename const &Shader::get_file(void) const; Filename: shader.I Created by: jyelon (01Sep05) 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: Returns null string if shader was not loaded from a source file.

getLoaded bool Shader::get_loaded(void) const; Description:

getLoadError bool Shader::get_load_error(void) const; Description:

getName string const &Shader::get_name(void) const; Description:

getPreprocessor int Shader::get_preprocessor(void) const; Description:

load static ConstPointerTo< Shader > Shader::load(Filename const &file, int preprocessor = (0)); Description:

macroexpand PointerTo< ShaderExpansion > Shader::macroexpand(RenderState const *context, ShaderExpansion::ShaderCaps const &caps) const; Description: The eventual plan is that shaders will be run through a macro preprocessor in order to generate the actual shader text in Cg, GLSL, HLSL, or whatever. The macro preprocessor will be able to query the RenderState and generate different shader code for different states. The macroexpansion of the shader is stored in an object of class ShaderExpansion. This is somewhat expensive to generate, so the ShaderExpansion is cached inside the the RenderState itself. The ShaderExpansion contains a map of ShaderContexts, each containing a compiled copy of the shader's macroexpansion. Any given shader might not contain any ifdefs that depend on the RenderState. If macroexpand determines that a given shader is not state-sensitive, it can cache the macroexpansion in the field "_fixed_expansion." The preprocessing is usually done by a built-in macro preprocessing function. However, the user can write his own preprocessor if he wishes to do so. A user- supplied preprocessor can generate arbitrary code --- in fact, it doesn't need to look at the input string if it does not wish to do so. Currently, macroexpand is just a stub that returns an expansion which is exactly equal to the input string. The "caps" parameter should describe the capabilities of the gsg on which this is intended to run.

make static ConstPointerTo< Shader > Shader::make(string const &body, int preprocessor = (0)); Description:

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

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

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.

testRefCountNonzero bool ReferenceCount::test_ref_count_nonzero(void) const; Description: Does some easy checks to make sure that the reference count isn't zero, or 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.