Package VisionEgg :: Module Textures :: Class TextureStimulusBaseClass |
[frames] | no frames]

# Class TextureStimulusBaseClass

source code

             object --+
                      |
    ClassWithParameters --+
                          |
              Core.Stimulus --+
                              |
                             TextureStimulusBaseClass

    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

Instance Methods
__init__(self, **kw) Instantiate and get ready to draw. | source code
Inherited from `Core.Stimulus`: `draw` Inherited from `ClassWithParameters`: `__getstate__`, `__setstate__`, `get_specified_type`, `is_constant_parameter`, `set`, `verify_parameters` Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__str__`

Class Variables
| parameters_and_defaults = `{'texture':(None, ve_types.Instance(`...``
| constant_parameters_and_defaults = `{'internal_format':(gl.GL_R`...``
Inherited from `ClassWithParameters`: `__safe_for_unpickling__`

Properties
Inherited from `object`: `__class__`

Method Details

### __init__(self, **kw) (Constructor) | source code
    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.
Overrides: Core.Stimulus.__init__ (inherited documentation)

Class Variable Details

  ### parameters_and_defaults Value:
      {'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),}

  ### constant_parameters_and_defaults Value:
      {'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?"),}