SoPostEffectCreateBuffer

InventorModule
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll SoRenderers
definition SoRenderers.def

Purpose

The SoPostEffectCreateBuffer module can be used to create new (empty) buffers in the SoPostEffectRenderer framework. The buffer can then be used as target for other modules, e.g. for SoPostEffectAdditionalGeometry.

Parameter Fields

Field Index

Buffer Name: String Size Mode: Enum
Buffer Type: Enum  
Clear Alpha: Float  
Clear Color: Color  
Clear Depth: Float  
Enabled: Bool  
Fixed Size: IntVector2  
Scale Factor: Float  

Visible Fields

Enabled

name: enabled, type: Bool, default: TRUE

Enables the module.

Buffer Name

name: bufferName, type: String, default: newBuffer

The name of the buffer.

Buffer Type

name: bufferType, type: Enum, default: DEFAULT_RGBA

The type of the buffer.

Values:

Title Name Description
Default Rgb DEFAULT_RGB Uses the default RGB color format of the renderer.
Default Rgba DEFAULT_RGBA Uses the default RGBA color format of the renderer.
Default Depth DEFAULT_DEPTH Uses the default depth format of the renderer.
Rgb8 RGB8  
Rgba8 RGBA8  
Rgb16f RGB16F  
Rgba16f RGBA16F  
Rgb10 A2 RGB10_A2  
R8 R8  
R16f R16F  
R32f R32F  
Depth Component24 DEPTH_COMPONENT24  
Depth Component32 DEPTH_COMPONENT32  
Depth24 Stencil8 DEPTH24_STENCIL8  
Depth32f Stencil8 DEPTH32F_STENCIL8  

Fixed Size

name: fixedSize, type: IntVector2, default: 512 512

Gives a fixed size for the buffer. This is still scaled with the Scale Factor.

Scale Factor

name: scaleFactor, type: Float, default: 1

Scales the buffer size by the given scale factor.

Clear Alpha

name: clearAlpha, type: Float, default: 0

The clear value for the alpha channel.

Clear Depth

name: clearDepth, type: Float, default: 1

The clear value for the depth formats.

Clear Color

name: clearColor, type: Color, default: 1 1 1

The clear color.

Size Mode

name: sizeMode, type: Enum, default: ScreenSize

Defines how the size is calculated.

Values:

Title Name Description
Real Screen Size RealScreenSize The real size (as visible on the screen). This is not affected by multisampling.
Screen Size ScreenSize The screen size, which is scaled by the multisampling if enabled.
Fixed Size FixedSize A fixed size is provided. This is still scaled by Scale Factor.