Click or drag to resize
SoShaderParameterImage Class

Shader parameter node storing a texture image.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoShaderParameterImage : SoShaderParameter

The SoShaderParameterImage type exposes the following members.

Constructors
  NameDescription
Public methodSoShaderParameterImage
Initializes a new instance of the SoShaderParameterImage class
Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoNode.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoNode.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoNode.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount
(Inherited from SoNode.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
(Inherited from SoNode.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

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.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoNode.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertyaccessMode

Specifies the type of access that will be performed on the image.

Public propertyidentifier

Specifies the parameter's integer name which is declared and used within low-level shading programs.

(Inherited from SoShaderParameter.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertylayer

Specifies the layer of texture to be bound to the image unit.

Public propertyname

Specifies the parameter's string name which is declared and used within high-level shading programs.

(Inherited from SoShaderParameter.)
Public propertytexture

Specifies the texture to bind to the image unit.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

This 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;
Use "restrict" to allow the compiler to make optimizations when you know that this variable is the only one that will access the underlying texture. Also note that the name of the variable ("myTexture" in the example) should correspond to the value of the field name.

FILE FORMAT/DEFAULT

ShaderParameterImage {
name ""
identifier 0
texture NULL
layer -1
accessMode READ
}

Note Note

Node available since Open Inventor 10.12

See Also