cgshaderprogram.html

JAVA多媒体开发类库说明

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="CgShaderProgram()"><!-- --></A><H3>
CgShaderProgram</H3>
<PRE>
public <B>CgShaderProgram</B>()</PRE>
<DL>
<DD>Constructs a Cg shader program node component.

 <br>
 TODO: ADD MORE DOCUMENTATION HERE.
<P>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="setVertexAttrNames(java.lang.String[])"><!-- --></A><H3>
setVertexAttrNames</H3>
<PRE>
public void <B>setVertexAttrNames</B>(java.lang.String[]&nbsp;vertexAttrNames)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html#setVertexAttrNames(java.lang.String[])">ShaderProgram</A></CODE></B></DD>
<DD>Sets the vertex attribute names array for this ShaderProgram
 object. Each element in the array specifies the shader
 attribute name that is bound to the corresponding numbered
 vertex attribute within a GeometryArray object that uses this
 shader program. Array element 0 specifies the name of
 GeometryArray vertex attribute 0, array element 1 specifies the
 name of GeometryArray vertex attribute 1, and so forth.
 The array of names may be null or empty (0 length), but the
 elements of the array must be non-null.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html#setVertexAttrNames(java.lang.String[])">setVertexAttrNames</A></CODE> in class <CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html" title="class in javax.media.j3d">ShaderProgram</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>vertexAttrNames</CODE> - array of vertex attribute names for this
 shader program. A copy of this array is made.</DL>
</DD>
</DL>
<HR>

<A NAME="getVertexAttrNames()"><!-- --></A><H3>
getVertexAttrNames</H3>
<PRE>
public java.lang.String[] <B>getVertexAttrNames</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html#getVertexAttrNames()">ShaderProgram</A></CODE></B></DD>
<DD>Retrieves the vertex attribute names array from this
 ShaderProgram object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html#getVertexAttrNames()">getVertexAttrNames</A></CODE> in class <CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html" title="class in javax.media.j3d">ShaderProgram</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a copy of this ShaderProgram's array of vertex attribute names.</DL>
</DD>
</DL>
<HR>

<A NAME="setShaderAttrNames(java.lang.String[])"><!-- --></A><H3>
setShaderAttrNames</H3>
<PRE>
public void <B>setShaderAttrNames</B>(java.lang.String[]&nbsp;shaderAttrNames)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html#setShaderAttrNames(java.lang.String[])">ShaderProgram</A></CODE></B></DD>
<DD>Sets the shader attribute names array for this ShaderProgram
 object. Each element in the array specifies a shader
 attribute name that may be set via a ShaderAttribute object.
 Only those attributes whose names that appear in the shader
 attribute names array can be set for a given shader program.
 The array of names may be null or empty (0 length), but the
 elements of the array must be non-null.

 <p>
 TODO: finish this.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html#setShaderAttrNames(java.lang.String[])">setShaderAttrNames</A></CODE> in class <CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html" title="class in javax.media.j3d">ShaderProgram</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shaderAttrNames</CODE> - array of shader attribute names for this
 shader program. A copy of this array is made.</DL>
</DD>
</DL>
<HR>

<A NAME="getShaderAttrNames()"><!-- --></A><H3>
getShaderAttrNames</H3>
<PRE>
public java.lang.String[] <B>getShaderAttrNames</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html#getShaderAttrNames()">ShaderProgram</A></CODE></B></DD>
<DD>Retrieves the shader attribute names array from this
 ShaderProgram object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html#getShaderAttrNames()">getShaderAttrNames</A></CODE> in class <CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html" title="class in javax.media.j3d">ShaderProgram</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a copy of this ShaderProgram's array of shader attribute names.</DL>
</DD>
</DL>
<HR>

<A NAME="setShaders(javax.media.j3d.Shader[])"><!-- --></A><H3>
setShaders</H3>
<PRE>
public void <B>setShaders</B>(<A HREF="../../../javax/media/j3d/Shader.html" title="class in javax.media.j3d">Shader</A>[]&nbsp;shaders)</PRE>
<DL>
<DD>Copies the specified array of shaders into this shader
 program. This method makes a shallow copy of the array. The
 array of shaders may be null or empty (0 length), but the
 elements of the array must be non-null. The shading language of
 each shader in the array must be
 <code>SHADING_LANGUAGE_CG</code>. Each shader in the array must
 be a SourceCodeShader. There must be no more than one vertex shader
 and one fragment shader in the array.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html#setShaders(javax.media.j3d.Shader[])">setShaders</A></CODE> in class <CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html" title="class in javax.media.j3d">ShaderProgram</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shaders</CODE> - array of Shader objects to be copied into this
 ShaderProgram
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">CapabilityNotSetException</A></CODE> - if appropriate capability is
 not set and this object is part of live or compiled scene graph
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the shading language of
 any shader in the shaders array is <em>not</em>
 <code>SHADING_LANGUAGE_CG</code>.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if there are more than one
 vertex shader or more than one fragment shader in the shaders
 array.
<DD><CODE>java.lang.ClassCastException</CODE> - if any shader in the shaders
 array is <em>not</em> a SourceCodeShader.</DL>
</DD>
</DL>
<HR>

<A NAME="getShaders()"><!-- --></A><H3>
getShaders</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/Shader.html" title="class in javax.media.j3d">Shader</A>[] <B>getShaders</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html#getShaders()">ShaderProgram</A></CODE></B></DD>
<DD>Retrieves the array of shaders from this shader program. A
 shallow copy of the array is returned. The return value may
 be null.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html#getShaders()">getShaders</A></CODE> in class <CODE><A HREF="../../../javax/media/j3d/ShaderProgram.html" title="class in javax.media.j3d">ShaderProgram</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a copy of this ShaderProgram's array of Shader objects</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../javax/media/j3d/Clip.html" title="class in javax.media.j3d"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?javax/media/j3d/CgShaderProgram.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="CgShaderProgram.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_javax.media.j3d.ShaderProgram">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<font size="-1">Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to <a href="../../../LICENSE-SPEC.html">license terms</a>.
</BODY>
</HTML>