<?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.Texture</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 Texture
</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.Texture-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Texture</h1><span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture">source code</a></span><br /><br />
<pre class="base-tree">
object --+
|
<strong class="uidshort">Texture</strong>
</pre>
<hr />
<pre class="literalblock">
A 2 dimensional texture.
The pixel data can come from an image file, an image file stream,
an instance of Image from the Python Imaging Library, a numpy
array, or None.
If the data is a numpy array, floating point numbers are assumed
to be in the range 0.0 to 1.0, and integers are assumed to be in
the range 0 to 255. The first index is the row (y position), the
second index is the column (x position), and if it's RGB or RGBA
data, the third index specifies the color band. Thus, if the
texel data was 640 pixels wide by 480 pixels tall, the array would
have shape (480,640) for luminance information, (480,640,3) for
RGB information, and (480,640,4) for RGBA information.
The 2D texture data is not sent to OpenGL (video texture memory)
until the load() method is called. The unload() method may be
used to remove the data from OpenGL.
A reference to the original image data is maintained.
</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.Texture-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">texels</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">size</span>=<span class="summary-sig-default">None</span>)</span><br />
Creates instance of Texture object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture.__init__">source code</a></span>
</td>
</tr>
</table>
</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.Texture-class.html#update" class="summary-sig-name">update</a>(<span class="summary-sig-arg">self</span>)</span><br />
Update texture data
This method does nothing, but may be overriden in classes that
need to update their texture data whenever drawn.</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture.update">source code</a></span>
</td>
</tr>
</table>
</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 name="make_half_size"></a><span class="summary-sig-name">make_half_size</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture.make_half_size">source code</a></span>
</td>
</tr>
</table>
</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.Texture-class.html#unload" class="summary-sig-name">unload</a>(<span class="summary-sig-arg">self</span>)</span><br />
Unload texture data from video texture memory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture.unload">source code</a></span>
</td>
</tr>
</table>
</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 name="get_texels_as_image"></a><span class="summary-sig-name">get_texels_as_image</span>(<span class="summary-sig-arg">self</span>)</span><br />
Return texel data as PIL image</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture.get_texels_as_image">source code</a></span>
</td>
</tr>
</table>
</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 name="get_pixels_as_image"></a><span class="summary-sig-name">get_pixels_as_image</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture.get_pixels_as_image">source code</a></span>
</td>
</tr>
</table>
</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.Texture-class.html#load" class="summary-sig-name">load</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">texture_object</span>,
<span class="summary-sig-arg">build_mipmaps</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">rescale_original_to_fill_texture_object</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">internal_format</span>=<span class="summary-sig-default">gl.GL_RGB</span>)</span><br />
Load texture data to video texture memory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture.load">source code</a></span>
</td>
</tr>
</table>
</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 name="get_texture_object"></a><span class="summary-sig-name">get_texture_object</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture.get_texture_object">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<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>
<!-- ==================== 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">texels</span>=<span class="sig-default">None</span>,
<span class="sig-arg">size</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture.__init__">source code</a></span>
</td>
</table>
<pre class="literalblock">
Creates instance of Texture object.
texels -- Texture data. If not specified, a blank white
texture is created.
size -- If a tuple, force size of texture data if possible,
raising an exception if not. If None, has no effect.
</pre>
<dl class="fields">
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="update"></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">update</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture.update">source code</a></span>
</td>
</table>
<pre class="literalblock">
Update texture data
This method does nothing, but may be overriden in classes that
need to update their texture data whenever drawn.
It it called by the draw() method of any stimuli using
textures when its texture object is active, so it can safely
use put_sub_image() to manipulate its own texture data.
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="unload"></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">unload</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture.unload">source code</a></span>
</td>
</table>
<pre class="literalblock">
Unload texture data from video texture memory.
This only removes data from the video texture memory if there
are no other references to the TextureObject instance. To
ensure this, all references to the texture_object argument
passed to the load() method should be deleted.
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="load"></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">load</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">texture_object</span>,
<span class="sig-arg">build_mipmaps</span>=<span class="sig-default">True</span>,
<span class="sig-arg">rescale_original_to_fill_texture_object</span>=<span class="sig-default">False</span>,
<span class="sig-arg">internal_format</span>=<span class="sig-default">gl.GL_RGB</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="VisionEgg.Textures-pysrc.html#Texture.load">source code</a></span>
</td>
</table>
<pre class="literalblock">
Load texture data to video texture memory.
This will cause the texture data to become resident in OpenGL
video texture memory, enabling fast drawing.
The texture_object argument is used to specify an instance of
the TextureObject class, which is a wrapper for the OpenGL
texture object holding the resident texture.
To remove a texture from OpenGL's resident textures: TextureObject passed as the texture_object argument and 2)
call the unload() method
</pre>
<dl class="fields">
</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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
b4347e6708d280a7ffb2b5b2ea3cdb9d
>
files
>
466
