ShaderProgram (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DNode, X3DProgrammableShaderObject, X3DUrlObject

All Known Implementing Classes:

ShaderProgramObject
```
public interface ShaderProgram
extends X3DNode, X3DUrlObject, X3DProgrammableShaderObject
```
ShaderProgram can contain field declarations and a CDATA section of plain-text source code.

X3D node tooltip: (X3D version 3.1 or later) [X3DNode,X3DUrlObject,X3DProgrammableShaderObject] ShaderProgram is contained by ProgramShader and provides the source and interface to a self-contained program that occupies one part of the rendering process: either a vertex or fragment shader.
- Hint: ShaderProgram contains field declarations and then corresponding IS/connect statements (if any).
- Hint: insert a CDATA block to contain source code embedded within an X3D scene.
- Hint: a contained CDATA block for source code protects whitespace, line breaks, and literal characters (such as & for ampersand character, < for less-than-sign character, and > for greater-than-sign character) from unintended escape-character modifications by XML parsers.
- Warning: strict order is required for contained constructs: first field declarations (if any), then IS/connect statements (if any), and finally CDATA source-code block.
- Hint: apply containerField='watchList' when parent node is LoadSensor.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

SAI Java Specification: TODO, X3D Abstract Specification: ShaderProgram, X3D Tooltips: ShaderProgram, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`java.lang.String`	`getType()` Provide String enumeration value ['VERTEX'\|'FRAGMENT'\|'etc.'] from inputOutput SFString field named type.
`java.lang.String[]`	`getUrl()` Provide array of String results from inputOutput MFString field named url.
`ShaderProgram`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`ShaderProgram`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`ShaderProgram`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`ShaderProgram`	`setType(java.lang.String newValue)` Assign String enumeration value ("VERTEX"\|"FRAGMENT") ['VERTEX'\|'FRAGMENT'\|'etc.'] to inputOutput SFString field named type.
`ShaderProgram`	`setUrl(java.lang.String[] newValue)` Assign String array to inputOutput MFString field named url.
`ShaderProgram`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
ShaderProgram setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getType
```
java.lang.String getType()
```
    Provide String enumeration value ['VERTEX'|'FRAGMENT'|'etc.'] from inputOutput SFString field named type.
    
    Tooltip: type indicates whether this ShaderProgram is a vertex or fragment (pixel) shader.
    - Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
    Returns:
    
    value of type field
  - setType
```
ShaderProgram setType(java.lang.String newValue)
```
    Assign String enumeration value ("VERTEX"|"FRAGMENT") ['VERTEX'|'FRAGMENT'|'etc.'] to inputOutput SFString field named type.
    
    Tooltip: type indicates whether this ShaderProgram is a vertex or fragment (pixel) shader. Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
    
    Parameters:
    
    newValue - is new value for the type field.
    
    Returns:
    
    ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getUrl
```
java.lang.String[] getUrl()
```
    Provide array of String results from inputOutput MFString field named url.
    
    Tooltip: Location and filename of shader. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.
    - Hint: MFString arrays can have multiple values, so separate each individual string by quote marks
      "http://www.web3d.org"
      "http://www.web3d.org/about" "etc."
    - Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
    - Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
    - Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
    - Hint: X3D Scene Authoring Hints, urls
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
    Specified by:
    
    getUrl in interface X3DUrlObject
    
    Returns:
    
    value of url field
  - setUrl
```
ShaderProgram setUrl(java.lang.String[] newValue)
```
    Assign String array to inputOutput MFString field named url.
    
    Tooltip: Location and filename of shader. Multiple locations are more reliable, and including a Web address lets e-mail attachments work. Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc." Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity). Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches. Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Hint: X3D Scene Authoring Hints, urls http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
    
    Specified by:
    
    setUrl in interface X3DUrlObject
    
    Parameters:
    
    newValue - is new value for the url field.
    
    Returns:
    
    ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
ShaderProgram setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DProgrammableShaderObject
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
ShaderProgram setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DProgrammableShaderObject
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
ShaderProgram setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DProgrammableShaderObject
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface ShaderProgram

Method Summary

Method Detail

getMetadata

setMetadata

getType

setType

getUrl

setUrl

setDEF

setUSE

setCssClass