Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 60f1dc962abad0f3b492991a4fbef9be > files > 5339

vtk-doc-5.4.2-5mdv2010.0.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: dox/Rendering/vtkShader.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="classes.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
<h1>dox/Rendering/vtkShader.h</h1><a href="a03547.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*=========================================================================</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment">  Program:   Visualization Toolkit</span>
<a name="l00004"></a>00004 <span class="comment">  Module:    $RCSfile: vtkShader.h,v $</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen</span>
<a name="l00007"></a>00007 <span class="comment">  All rights reserved.</span>
<a name="l00008"></a>00008 <span class="comment">  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">     This software is distributed WITHOUT ANY WARRANTY; without even</span>
<a name="l00011"></a>00011 <span class="comment">     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR</span>
<a name="l00012"></a>00012 <span class="comment">     PURPOSE.  See the above copyright notice for more information.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">=========================================================================*/</span>
<a name="l00015"></a>00015 <span class="comment">/*</span>
<a name="l00016"></a>00016 <span class="comment"> * Copyright 2003 Sandia Corporation.</span>
<a name="l00017"></a>00017 <span class="comment"> * Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive</span>
<a name="l00018"></a>00018 <span class="comment"> * license for use of this work by or on behalf of the</span>
<a name="l00019"></a>00019 <span class="comment"> * U.S. Government. Redistribution and use in source and binary forms, with</span>
<a name="l00020"></a>00020 <span class="comment"> * or without modification, are permitted provided that this Notice and any</span>
<a name="l00021"></a>00021 <span class="comment"> * statement of authorship are reproduced on all copies.</span>
<a name="l00022"></a>00022 <span class="comment"> */</span>
<a name="l00023"></a>00023 
<a name="l00042"></a>00042 <span class="preprocessor">#ifndef __vtkShader_h</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define __vtkShader_h</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span>
<a name="l00045"></a>00045 <span class="preprocessor">#include "<a class="code" href="a02079.html">vtkObject.h</a>"</span>
<a name="l00046"></a>00046 
<a name="l00047"></a>00047 <span class="keyword">class </span><a class="code" href="a00092.html" title="represents an object (geometry &amp;amp; properties) in a rendered scene">vtkActor</a>;
<a name="l00048"></a>00048 <span class="keyword">class </span><a class="code" href="a00227.html" title="a virtual camera for 3D rendering">vtkCamera</a>;
<a name="l00049"></a>00049 <span class="keyword">class </span><a class="code" href="a00954.html" title="a virtual light for 3D rendering">vtkLight</a>;
<a name="l00050"></a>00050 <span class="keyword">class </span><a class="code" href="a01322.html" title="represent surface properties of a geometric object">vtkProperty</a>;
<a name="l00051"></a>00051 <span class="keyword">class </span><a class="code" href="a01480.html" title="abstract specification for renderers">vtkRenderer</a>;
<a name="l00052"></a>00052 <span class="keyword">class </span>vtkShaderInternals;
<a name="l00053"></a>00053 <span class="keyword">class </span><a class="code" href="a01695.html" title="handles properties associated with a texture map">vtkTexture</a>;
<a name="l00054"></a>00054 <span class="keyword">class </span><a class="code" href="a01886.html" title="window superclass for vtkRenderWindow">vtkWindow</a>;
<a name="l00055"></a>00055 <span class="keyword">class </span><a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>;
<a name="l00056"></a>00056 <span class="keyword">class </span><a class="code" href="a01946.html" title="encapsulates a Shader XML description.">vtkXMLShader</a>;
<a name="l00057"></a>00057 
<a name="l00058"></a><a class="code" href="a01532.html">00058</a> <span class="keyword">class </span><a class="code" href="a02170.html#4019f67b2e7d601f2cf984e448308dbb">VTK_RENDERING_EXPORT</a> <a class="code" href="a01532.html">vtkShader</a> : <span class="keyword">public</span> <a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 <span class="keyword">public</span>:
<a name="l00061"></a><a class="code" href="a01532.html#94f08a10b823c27478f71e56c26521e0">00061</a>   vtkTypeRevisionMacro(<a class="code" href="a01532.html">vtkShader</a>, <a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>);
<a name="l00062"></a>00062   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a01084.html#bf3dbb4154289b56a12483eee3866263">PrintSelf</a>(ostream &amp;os, <a class="code" href="a00869.html" title="a simple class to control print indentation">vtkIndent</a> indent);
<a name="l00063"></a>00063 
<a name="l00068"></a>00068   <span class="keyword">virtual</span> <span class="keywordtype">int</span> Compile() =0;
<a name="l00069"></a>00069 
<a name="l00073"></a>00073   <span class="keyword">virtual</span> <span class="keywordtype">void</span> PassShaderVariables(<a class="code" href="a00092.html" title="represents an object (geometry &amp;amp; properties) in a rendered scene">vtkActor</a>* actor, <a class="code" href="a01480.html" title="abstract specification for renderers">vtkRenderer</a>* ren);
<a name="l00074"></a>00074 
<a name="l00078"></a><a class="code" href="a01532.html#9244170a906a5133179a5b34d0ce4aa7">00078</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span>  Bind() { }
<a name="l00079"></a>00079 
<a name="l00082"></a><a class="code" href="a01532.html#fe897483d82537f4c8e75ca691730d1b">00082</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Unbind() { }
<a name="l00083"></a>00083 
<a name="l00087"></a><a class="code" href="a01532.html#2fec3459ae3da55145738f9dcbbfb58e">00087</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> ReleaseGraphicsResources(<a class="code" href="a01886.html" title="window superclass for vtkRenderWindow">vtkWindow</a> *) { }
<a name="l00088"></a>00088   
<a name="l00090"></a>00090 
<a name="l00092"></a>00092   <span class="keywordtype">void</span> SetXMLShader(<a class="code" href="a01946.html" title="encapsulates a Shader XML description.">vtkXMLShader</a>*);
<a name="l00093"></a>00093   vtkGetObjectMacro(XMLShader, <a class="code" href="a01946.html" title="encapsulates a Shader XML description.">vtkXMLShader</a>);
<a name="l00095"></a>00095 
<a name="l00097"></a>00097   <span class="keywordtype">int</span> HasShaderVariable(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>);
<a name="l00098"></a>00098 
<a name="l00100"></a>00100 
<a name="l00103"></a>00103   <span class="keywordtype">void</span> AddShaderVariable(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keywordtype">int</span> num_of_elements,
<a name="l00104"></a>00104     <span class="keyword">const</span> <span class="keywordtype">int</span> *values);
<a name="l00105"></a>00105   <span class="keywordtype">void</span> AddShaderVariable(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keywordtype">int</span> num_of_elements,
<a name="l00106"></a>00106     <span class="keyword">const</span> <span class="keywordtype">float</span> *values);
<a name="l00107"></a>00107   <span class="keywordtype">void</span> AddShaderVariable(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keywordtype">int</span> num_of_elements,
<a name="l00108"></a>00108     <span class="keyword">const</span> <span class="keywordtype">double</span> *values);
<a name="l00110"></a>00110 
<a name="l00113"></a>00113   <span class="keywordtype">int</span> GetShaderVariableSize(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>);
<a name="l00114"></a>00114 
<a name="l00117"></a>00117   <span class="keywordtype">int</span> GetShaderVariableType(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>);
<a name="l00118"></a>00118   
<a name="l00120"></a>00120 
<a name="l00123"></a>00123   <span class="keywordtype">int</span> GetShaderVariable(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keywordtype">int</span>* values);
<a name="l00124"></a>00124   <span class="keywordtype">int</span> GetShaderVariable(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keywordtype">float</span>* values);
<a name="l00125"></a>00125   <span class="keywordtype">int</span> GetShaderVariable(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keywordtype">double</span>* values);
<a name="l00127"></a>00127 
<a name="l00130"></a>00130   <span class="keywordtype">int</span> GetScope();
<a name="l00131"></a>00131 <span class="keyword">protected</span>:
<a name="l00132"></a>00132   <a class="code" href="a01532.html">vtkShader</a>();
<a name="l00133"></a>00133   ~<a class="code" href="a01532.html">vtkShader</a>();
<a name="l00134"></a>00134 
<a name="l00135"></a><a class="code" href="a01532.html#60162349f53a29df64f2495e06b7cba3">00135</a>   <a class="code" href="a01946.html" title="encapsulates a Shader XML description.">vtkXMLShader</a>* XMLShader;
<a name="l00136"></a><a class="code" href="a01532.html#25cd31102f60baaec1642434bc3a4bd5">00136</a>   vtkShaderInternals* Internals;
<a name="l00137"></a>00137 
<a name="l00138"></a>00138   <span class="comment">//BTX</span>
<a name="l00139"></a><a class="code" href="a01532.html#c94ceb18bf60e9822b210a14f85f1d02">00139</a>   <span class="keyword">enum</span> <a class="code" href="a01532.html#c94ceb18bf60e9822b210a14f85f1d02">MatrixOrders</a>
<a name="l00140"></a>00140     {
<a name="l00141"></a><a class="code" href="a01532.html#c94ceb18bf60e9822b210a14f85f1d02daf46ce5ef9889ee2c9888e658c09093">00141</a>     RowMajor,
<a name="l00142"></a><a class="code" href="a01532.html#c94ceb18bf60e9822b210a14f85f1d024673d142f4c54462cc9e6c2f87c1ab0f">00142</a>     ColumnMajor
<a name="l00143"></a>00143     };
<a name="l00144"></a>00144   <span class="comment">//ETX</span>
<a name="l00145"></a>00145 
<a name="l00147"></a>00147 
<a name="l00149"></a>00149   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetShaderParameters(<a class="code" href="a00092.html" title="represents an object (geometry &amp;amp; properties) in a rendered scene">vtkActor</a>*, <a class="code" href="a01480.html" title="abstract specification for renderers">vtkRenderer</a>*,
<a name="l00150"></a>00150                                    <a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>*);
<a name="l00152"></a>00152   
<a name="l00153"></a>00153   
<a name="l00155"></a>00155   <span class="keywordtype">void</span> SetUniformParameter(<a class="code" href="a00092.html" title="represents an object (geometry &amp;amp; properties) in a rendered scene">vtkActor</a>*, <a class="code" href="a01480.html" title="abstract specification for renderers">vtkRenderer</a>*, <a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>*);
<a name="l00156"></a>00156 
<a name="l00158"></a>00158   <span class="keywordtype">void</span> SetCameraParameter(<a class="code" href="a00092.html" title="represents an object (geometry &amp;amp; properties) in a rendered scene">vtkActor</a>*, <a class="code" href="a01480.html" title="abstract specification for renderers">vtkRenderer</a>*, <a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>*);
<a name="l00159"></a>00159 
<a name="l00161"></a>00161   <span class="keywordtype">void</span> SetPropertyParameter(<a class="code" href="a00092.html" title="represents an object (geometry &amp;amp; properties) in a rendered scene">vtkActor</a>*, <a class="code" href="a01480.html" title="abstract specification for renderers">vtkRenderer</a>*, <a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>*);
<a name="l00162"></a>00162 
<a name="l00164"></a>00164   <span class="keywordtype">void</span> SetLightParameter(<a class="code" href="a00092.html" title="represents an object (geometry &amp;amp; properties) in a rendered scene">vtkActor</a>*, <a class="code" href="a01480.html" title="abstract specification for renderers">vtkRenderer</a>*, <a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>*);
<a name="l00165"></a>00165 
<a name="l00167"></a>00167   <span class="keywordtype">void</span> SetMatrixParameter(<a class="code" href="a00092.html" title="represents an object (geometry &amp;amp; properties) in a rendered scene">vtkActor</a>*, <a class="code" href="a01480.html" title="abstract specification for renderers">vtkRenderer</a>*, <a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>*);
<a name="l00168"></a>00168 
<a name="l00170"></a>00170   <span class="keywordtype">void</span> SetSamplerParameter(<a class="code" href="a00092.html" title="represents an object (geometry &amp;amp; properties) in a rendered scene">vtkActor</a>*, <a class="code" href="a01480.html" title="abstract specification for renderers">vtkRenderer</a>*, <a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>*);
<a name="l00171"></a>00171 
<a name="l00173"></a>00173   <span class="keywordtype">void</span> SetApplicationParameter(<a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>*);
<a name="l00174"></a>00174 
<a name="l00176"></a>00176 
<a name="l00178"></a>00178   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetUniformParameter(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keywordtype">int</span> numValues, 
<a name="l00179"></a>00179     <span class="keyword">const</span> <span class="keywordtype">int</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>) =0;
<a name="l00180"></a>00180   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetUniformParameter(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keywordtype">int</span> numValues, 
<a name="l00181"></a>00181     <span class="keyword">const</span> <span class="keywordtype">float</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>)=0;
<a name="l00182"></a>00182   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetUniformParameter(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keywordtype">int</span> numValues, 
<a name="l00183"></a>00183     <span class="keyword">const</span> <span class="keywordtype">double</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>)=0;
<a name="l00185"></a>00185 
<a name="l00187"></a>00187 
<a name="l00189"></a>00189   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetMatrixParameter(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keywordtype">int</span> numValues, 
<a name="l00190"></a>00190     <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2101120342919d8f583cb57e39394154f33">order</a>, <span class="keyword">const</span> <span class="keywordtype">float</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>)=0;
<a name="l00191"></a>00191   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetMatrixParameter(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keywordtype">int</span> numValues, 
<a name="l00192"></a>00192     <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2101120342919d8f583cb57e39394154f33">order</a>, <span class="keyword">const</span> <span class="keywordtype">double</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>)=0;
<a name="l00193"></a>00193   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetMatrixParameter(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keyword">const</span> <span class="keywordtype">char</span>* state_matix_type,
<a name="l00194"></a>00194     <span class="keyword">const</span> <span class="keywordtype">char</span>* transform_type)=0;
<a name="l00196"></a>00196 
<a name="l00197"></a>00197 
<a name="l00199"></a>00199 
<a name="l00204"></a>00204   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetSamplerParameter(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <a class="code" href="a01695.html" title="handles properties associated with a texture map">vtkTexture</a>* texture,
<a name="l00205"></a>00205                                    <span class="keywordtype">int</span> textureIndex)=0;
<a name="l00207"></a>00207  
<a name="l00208"></a><a class="code" href="a01532.html#a78b1cab682aa9755462e5117d880ef7">00208</a>   <a class="code" href="a01719.html" title="record modification and/or execution time">vtkTimeStamp</a> PassShaderVariablesTime;
<a name="l00209"></a>00209 <span class="keyword">private</span>:
<a name="l00210"></a>00210   <a class="code" href="a01532.html">vtkShader</a>(<span class="keyword">const</span> <a class="code" href="a01532.html">vtkShader</a>&amp;); <span class="comment">// Not Implemented</span>
<a name="l00211"></a>00211   <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="a01532.html">vtkShader</a>&amp;); <span class="comment">// Not Implemented</span>
<a name="l00212"></a>00212 };
<a name="l00213"></a>00213 <span class="preprocessor">#endif //__vtkShader_h</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35:49 2009 for VTK by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>