| SoShaderParameterImage Class |
Shader parameter node storing a texture image.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoShaderParameter
OIV.Inventor.NodesSoShaderParameterImage
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.1.0 (2024.1.1)
SyntaxThe SoShaderParameterImage type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoShaderParameterImage | Initializes a new instance of the SoShaderParameterImage class |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoNode.) |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Inherited from SoNode.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Inherited from SoNode.) |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoNode.) |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | (Inherited from SoNode.) |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Inherited from SoNode.) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoNode.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoNode.) |
| RayPick | (Inherited from SoNode.) |
| Search | (Inherited from SoNode.) |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoNode.) |
Properties| Name | Description | |
|---|---|---|
 | accessMode | Specifies the type of access that will be performed on the image. |
| identifier | Specifies the parameter's integer name which is declared and used within low-level shading programs. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| layer | Specifies the layer of texture to be bound to the image unit. |
| name | Specifies the parameter's string name which is declared and used within high-level shading programs. |
| texture | Specifies the texture to bind to the image unit. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThis node allows the application to bind a texture to an image unit for the purpose of reading and writing it from shaders. OIV.Inventor.Nodes.SoShaderParameterImage.texture specifies an existing texture node to bind to the image unit.
If OIV.Inventor.Nodes.SoShaderParameterImage.texture is an OIV.Inventor.Nodes.SoTextureCubeMap or an OIV.Inventor.Nodes.SoTexture3 with OIV.Inventor.Nodes.SoTexture3.Layouts.ARRAY layout, then it is possible to bind either the entire array, or only a single layer of the array to the image unit. In such cases, if OIV.Inventor.Nodes.SoShaderParameterImage.layer is -1, the entire array is attached to the image unit. Otherwise, OIV.Inventor.Nodes.SoShaderParameterImage.layer specifies the layer of the array to attach to the image unit.
OIV.Inventor.Nodes.SoShaderParameterImage.accessMode specifies the access types to be performed by shaders and may be set to OIV.Inventor.Nodes.SoShaderParameterImage.AccessModes.READ, OIV.Inventor.Nodes.SoShaderParameterImage.AccessModes.WRITE, or OIV.Inventor.Nodes.SoShaderParameterImage.AccessModes.READ_WRITE to indicate read-only, write-only or read-write access, respectively. Violation of the access type specified in OIV.Inventor.Nodes.SoShaderParameterImage.accessMode (for example, if a shader writes to an image bound with OIV.Inventor.Nodes.SoShaderParameterImage.accessMode set to OIV.Inventor.Nodes.SoShaderParameterImage.AccessModes.READ) will lead to undefined results, possibly including program termination.
OIV.Inventor.Nodes.SoShaderParameterImage nodes are usually added to the field OIV.Inventor.Nodes.SoShaderProgram.images to affect only that specific shader program, but can also be inserted in the scene graph and affect all subsequent shader programs.
See Image Load Store section of the OpenGL wiki for more information about using this feature in GLSL.
As an example, here is how you could define a 2D write-only texture in GLSL:
restrict writeonly uniform image2D myTexture;
FILE FORMAT/DEFAULT
ShaderParameterImage {
| name | "" |
| identifier | 0 |
| texture | NULL |
| layer | -1 |
| accessMode | READ |
 Note |
|---|
Node available since Open Inventor 10.12 |
See Also