<?xml version="1.0" encoding="ascii"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>VisionEgg.Textures.TextureStimulusBaseClass</title> <link rel="stylesheet" href="epydoc.css" type="text/css" /> <script type="text/javascript" src="epydoc.js"></script> </head> <body bgcolor="white" text="black" link="blue" vlink="#204080" alink="#204080"> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="VisionEgg-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" ><a class="navbar" target="_top" href="http://www.visionegg.org">Vision Egg</a></th> </tr></table></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> <a href="VisionEgg-module.html">Package VisionEgg</a> :: <a href="VisionEgg.Textures-module.html">Module Textures</a> :: Class TextureStimulusBaseClass </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> <tr><td align="right"><span class="options" >[<a href="frames.html" target="_top">frames</a >] | <a href="VisionEgg.Textures.TextureStimulusBaseClass-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class TextureStimulusBaseClass</h1><span class="codelink"><a href="VisionEgg.Textures-pysrc.html#TextureStimulusBaseClass">source code</a></span><br /><br /> <pre class="base-tree"> object --+ | <a href="VisionEgg.ClassWithParameters-class.html">ClassWithParameters</a> --+ | <a href="VisionEgg.Core.Stimulus-class.html">Core.Stimulus</a> --+ | <strong class="uidshort">TextureStimulusBaseClass</strong> </pre> <hr /> <pre class="literalblock"> Parameters common to all stimuli that use textures. Don't instantiate this class directly. Parameters ========== texture -- source of texture data (Instance of <class 'VisionEgg.Textures.Texture'>) Default: (determined at runtime) texture_mag_filter -- OpenGL filter enum (Integer) Default: GL_LINEAR (9729) texture_min_filter -- OpenGL filter enum (Integer) Default: (GL enum determined at runtime) texture_wrap_s -- OpenGL texture wrap enum (Integer) Default: (GL enum determined at runtime) texture_wrap_t -- OpenGL texture wrap enum (Integer) Default: (GL enum determined at runtime) Constant Parameters =================== internal_format -- format with which OpenGL uses texture data (OpenGL data type enum) (Integer) Default: GL_RGB (6407) mipmaps_enabled -- Are mipmaps enabled? (Boolean) Default: True shrink_texture_ok -- Allow automatic shrinking of texture if too big? (Boolean) Default: False </pre><br /><br /> <!-- ==================== INSTANCE METHODS ==================== --> <a name="section-InstanceMethods"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Instance Methods</span></td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="VisionEgg.Textures.TextureStimulusBaseClass-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">**kw</span>)</span><br /> Instantiate and get ready to draw.</td> <td align="right" valign="top"> <span class="codelink"><a href="VisionEgg.Textures-pysrc.html#TextureStimulusBaseClass.__init__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="VisionEgg.Core.Stimulus-class.html">Core.Stimulus</a></code></b>: <code><a href="VisionEgg.Core.Stimulus-class.html#draw">draw</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="VisionEgg.ClassWithParameters-class.html">ClassWithParameters</a></code></b>: <code><a href="VisionEgg.ClassWithParameters-class.html#__getstate__">__getstate__</a></code>, <code><a href="VisionEgg.ClassWithParameters-class.html#__setstate__">__setstate__</a></code>, <code><a href="VisionEgg.ClassWithParameters-class.html#get_specified_type">get_specified_type</a></code>, <code><a href="VisionEgg.ClassWithParameters-class.html#is_constant_parameter">is_constant_parameter</a></code>, <code><a href="VisionEgg.ClassWithParameters-class.html#set">set</a></code>, <code><a href="VisionEgg.ClassWithParameters-class.html#verify_parameters">verify_parameters</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__delattr__</code>, <code>__getattribute__</code>, <code>__hash__</code>, <code>__new__</code>, <code>__reduce__</code>, <code>__reduce_ex__</code>, <code>__repr__</code>, <code>__setattr__</code>, <code>__str__</code> </p> </td> </tr> </table> <!-- ==================== CLASS VARIABLES ==================== --> <a name="section-ClassVariables"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Class Variables</span></td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="VisionEgg.Textures.TextureStimulusBaseClass-class.html#parameters_and_defaults" class="summary-name">parameters_and_defaults</a> = <code title="{'texture':(None, ve_types.Instance(Texture), "source of texture data"\ ), 'texture_mag_filter':(gl.GL_LINEAR, ve_types.Integer, "OpenGL filte\ r enum", VisionEgg.ParameterDefinition.OPENGL_ENUM), 'texture_min_filt\ er':(None, ve_types.Integer, "OpenGL filter enum", VisionEgg.Parameter\ Definition.OPENGL_ENUM), 'texture_wrap_s':(None, ve_types.Integer, "Op\ enGL texture wrap enum", VisionEgg.ParameterDefinition.OPENGL_ENUM), '\ texture_wrap_t':(None, ve_types.Integer, "OpenGL texture wrap enum", V\ isionEgg.ParameterDefinition.OPENGL_ENUM),}">{'texture':(None, ve_types.Instance(<code class="variable-ellipsis">...</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="VisionEgg.Textures.TextureStimulusBaseClass-class.html#constant_parameters_and_defaults" class="summary-name">constant_parameters_and_defaults</a> = <code title="{'internal_format':(gl.GL_RGB, ve_types.Integer, "format with which Op\ enGL uses texture data (OpenGL data type enum)", VisionEgg.ParameterDe\ finition.OPENGL_ENUM), 'mipmaps_enabled':(True, ve_types.Boolean, "Are\ mipmaps enabled?"), 'shrink_texture_ok':(False, ve_types.Boolean, "Al\ low automatic shrinking of texture if too big?"),}">{'internal_format':(gl.GL_R<code class="variable-ellipsis">...</code></code> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="VisionEgg.ClassWithParameters-class.html">ClassWithParameters</a></code></b>: <code><a href="VisionEgg.ClassWithParameters-class.html#__safe_for_unpickling__">__safe_for_unpickling__</a></code> </p> </td> </tr> </table> <!-- ==================== PROPERTIES ==================== --> <a name="section-Properties"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Properties</span></td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__class__</code> </p> </td> </tr> </table> <!-- ==================== METHOD DETAILS ==================== --> <a name="section-MethodDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Method Details</span></td> </tr> </table> <a name="__init__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">**kw</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="VisionEgg.Textures-pysrc.html#TextureStimulusBaseClass.__init__">source code</a></span> </td> </table> <pre class="literalblock"> Instantiate and get ready to draw. Set parameter values and create anything needed to draw the stimulus including OpenGL state variables such display lists and texture objects. </pre> <dl class="fields"> <dt>Overrides: <a href="VisionEgg.Core.Stimulus-class.html#__init__">Core.Stimulus.__init__</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <br /> <!-- ==================== CLASS VARIABLE DETAILS ==================== --> <a name="section-ClassVariableDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Class Variable Details</span></td> </tr> </table> <a name="parameters_and_defaults"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">parameters_and_defaults</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> {'texture':(None, ve_types.Instance(Texture), "source of texture data"<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> ), 'texture_mag_filter':(gl.GL_LINEAR, ve_types.Integer, "OpenGL filte<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> r enum", VisionEgg.ParameterDefinition.OPENGL_ENUM), 'texture_min_filt<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> er':(None, ve_types.Integer, "OpenGL filter enum", VisionEgg.Parameter<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> Definition.OPENGL_ENUM), 'texture_wrap_s':(None, ve_types.Integer, "Op<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> enGL texture wrap enum", VisionEgg.ParameterDefinition.OPENGL_ENUM), '<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> texture_wrap_t':(None, ve_types.Integer, "OpenGL texture wrap enum", V<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> isionEgg.ParameterDefinition.OPENGL_ENUM),} </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <a name="constant_parameters_and_defaults"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">constant_parameters_and_defaults</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> {'internal_format':(gl.GL_RGB, ve_types.Integer, "format with which Op<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> enGL uses texture data (OpenGL data type enum)", VisionEgg.ParameterDe<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> finition.OPENGL_ENUM), 'mipmaps_enabled':(True, ve_types.Boolean, "Are<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> mipmaps enabled?"), 'shrink_texture_ok':(False, ve_types.Boolean, "Al<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> low automatic shrinking of texture if too big?"),} </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="VisionEgg-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" ><a class="navbar" target="_top" href="http://www.visionegg.org">Vision Egg</a></th> </tr></table></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> Generated by Epydoc 3.0beta1 on Sat Jun 7 15:40:10 2008 </td> <td align="right" class="footer"> <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> </td> </tr> </table> <script type="text/javascript"> <!-- // Private objects are initially displayed (because if // javascript is turned off then we want them to be // visible); but by default, we want to hide them. So hide // them unless we have a cookie that says to show them. checkCookie() // --> </script> </body> </html>