1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FreeMat: vtkPixelBufferObject</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FreeMat
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('vtkrendering_vtkpixelbufferobject.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkPixelBufferObject </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkrendering.html">Visualization Toolkit Rendering Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>Provides low-level access to GPU memory. Used to pass raw data to GPU. The data is uploaded into a pixel buffer.</p>
<p>To create an instance of class vtkPixelBufferObject, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkPixelBufferObject
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkPixelBufferObject has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, <code>obj</code> is an instance of the vtkPixelBufferObject class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkPixelBufferObject = obj.NewInstance ()</code> </li>
<li>
<code>vtkPixelBufferObject = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>obj.SetContext (vtkRenderWindow context)</code> - Get/Set the context. Context must be a vtkOpenGLRenderWindow. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions. </li>
<li>
<code>vtkRenderWindow = obj.GetContext ()</code> - Get/Set the context. Context must be a vtkOpenGLRenderWindow. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions. </li>
<li>
<code>int = obj.GetUsage ()</code> - Usage is a performance hint. Valid values are:<ul>
<li>StreamDraw specified once by A, used few times S</li>
<li>StreamRead specified once by R, queried a few times by A</li>
<li>StreamCopy specified once by R, used a few times S</li>
<li>StaticDraw specified once by A, used many times S</li>
<li>StaticRead specificed once by R, queried many times by A</li>
<li>StaticCopy specified once by R, used many times S</li>
<li>DynamicDraw respecified repeatedly by A, used many times S</li>
<li>DynamicRead respecified repeatedly by R, queried many times by A</li>
<li>DynamicCopy respecified repeatedly by R, used many times S A: the application S: as the source for GL drawing and image specification commands. R: reading data from the GL Initial value is StaticDraw, as in OpenGL spec. </li>
</ul>
</li>
<li>
<code>obj.SetUsage (int )</code> - Usage is a performance hint. Valid values are:<ul>
<li>StreamDraw specified once by A, used few times S</li>
<li>StreamRead specified once by R, queried a few times by A</li>
<li>StreamCopy specified once by R, used a few times S</li>
<li>StaticDraw specified once by A, used many times S</li>
<li>StaticRead specificed once by R, queried many times by A</li>
<li>StaticCopy specified once by R, used many times S</li>
<li>DynamicDraw respecified repeatedly by A, used many times S</li>
<li>DynamicRead respecified repeatedly by R, queried many times by A</li>
<li>DynamicCopy respecified repeatedly by R, used many times S A: the application S: as the source for GL drawing and image specification commands. R: reading data from the GL Initial value is StaticDraw, as in OpenGL spec. </li>
</ul>
</li>
<li>
<code>int = obj.GetType ()</code> - Get the type with which the data is loaded into the GPU. eg. VTK_FLOAT for float32, VTK_CHAR for byte, VTK_UNSIGNED_CHAR for unsigned byte etc. </li>
<li>
<code>int = obj.GetSize ()</code> - Get the size of the data loaded into the GPU. Size is in the number of elements of the uploaded Type. </li>
<li>
<code>int = obj.GetHandle ()</code> - Get the openGL buffer handle. </li>
<li>
<code>obj.BindToPackedBuffer ()</code> </li>
<li>
<code>obj.BindToUnPackedBuffer ()</code> - Inactivate the buffer. </li>
<li>
<code>obj.UnBind ()</code> - Inactivate the buffer. </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_vtkrendering.html">Visualization Toolkit Rendering Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:35 for FreeMat by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
</ul>
</div>
</body>
</html>
|
