SoFramebufferTexture

InventorModule

genre

Visualization

author

MeVis Medical Solutions AG

package

MeVisLab/Standard

dll

SoFrameBufferObjects

definition

SoFrameBufferObjects.def

see also

SoFramebufferTexture, SoCheckFramebufferObjectSupport

keywords

fbo

Purpose

The module SoFramebufferTexture renders the scene to a texture that can be mapped to shapes.

Details

The module uses the OpenGL GL_EXT_framebuffer_object extension, which must be supported for the module to operate.

Windows

Default Panel

../../../Modules/Inventor/SoFrameBufferObjects/mhelp/Images/Screenshots/SoFramebufferTexture._default.png

Input Fields

child

name: child, type: SoNode

Output Fields

self

name: self, type: SoNode

Parameter Fields

Field Index

Border Color: Vector4

pickCulling: Enum

Use stencil buffer: Bool

boundingBoxCaching: Enum

renderCaching: Enum

Wrap S: Enum

Clear Alpha: Float

renderCulling: Enum

Wrap T: Enum

Clear Color: Color

Size: IntVector2

Color Buffer Format: Enum

Size Multiplier: Float

Enable Border: Bool

Use depth buffer: Bool

Mag Filter: Enum

Use format hints: Bool

Min Filter: Enum

Use size hints: Bool

Visible Fields

Size

name: size, type: IntVector2, default: 64 64

Sets the size of the texture as a list of numbers separated by spaces.

Width and height must be a power of 2.

Clear Color

name: clearColor, type: Color, default: 0 0 0

Sets a clear color for the framebuffer texture.

Clear Alpha

name: clearAlpha, type: Float, default: 1, minimum: 0, maximum: 1

Sets a clear alpha value for the framebuffer texture.

Color Buffer Format

name: colorBufferFormat, type: Enum, default: RGBA

Defines the color format of the internal textures.

Values:

Title

Name

​Rgb

​RGB

​Rgb8

​RGB8

​Rgb16

​RGB16

​Rgb16f

​RGB16F

​Rgb32f

​RGB32F

​Rgba

​RGBA

​Rgba8

​RGBA8

​Rgba16

​RGBA16

​Rgba16f

​RGBA16F

​Rgba32f

​RGBA32F

Use depth buffer

name: depthBuffer, type: Bool, default: TRUE

If checked, a framebuffer for depth values is used.

Use stencil buffer

name: stencilBuffer, type: Bool, default: FALSE

If checked, a framebuffer for stencil values is used.

Use size hints

name: useSizeStateHints, type: Bool, default: FALSE

If checked, the Open Inventor traversal state is checked for the SoMLImageElement to determine the size for the texture.

Note: The texture size is not adapted to the next power of 2.

Use format hints

name: useFormatStateHints, type: Bool, default: FALSE

If checked, the Open Inventor traversal state is checked for the SoMLImageElement to determine the format (number of bits) for the texture by evaluation of the data type.

The value of the field Color Buffer Format is used to decide between RGB and RGBA formats.

Wrap S

name: wrapS, type: Enum, default: REPEAT

Defines how the textures are wrapped horizontally.

Values:

Title

Name

​Repeat

​REPEAT

​Clamp

​CLAMP

​Clamp To Edge

​CLAMP_TO_EDGE

​Clamp To Border

​CLAMP_TO_BORDER

​Mirrored Repeat

​MIRRORED_REPEAT

Wrap T

name: wrapT, type: Enum, default: REPEAT

Defines how the textures are wrapped vertically.

Values:

Title

Name

​Repeat

​REPEAT

​Clamp

​CLAMP

​Clamp To Edge

​CLAMP_TO_EDGE

​Clamp To Border

​CLAMP_TO_BORDER

​Mirrored Repeat

​MIRRORED_REPEAT

Min Filter

name: minFilter, type: Enum, default: LINEAR

Defines which texture minifying function is used whenever the pixel being textured maps to an area greater than one texture element.

Values:

Title

Name

​Nearest

​NEAREST

​Linear

​LINEAR

Mag Filter

name: magFilter, type: Enum, default: LINEAR

Defines which texture magnification function is used when the pixel being textured maps to an area less than or equal to one texture element.

Values:

Title

Name

​Nearest

​NEAREST

​Linear

​LINEAR

Enable Border

name: enableBorder, type: Bool, default: FALSE

If checked, a border color is used.

Border Color

name: borderColor, type: Vector4, default: 0 0 0 0

Sets the optional border color.

Size Multiplier

name: sizeMultiplier, type: Float, default: 1

If Use size hints is true, the texture size retrieved from SoMLImageElement is multiplied with this value in order to allow for over- or undersampling.

Hidden Fields

renderCaching

name: renderCaching, type: Enum, default: AUTO

Values:

Title

Name

​On

​ON

​Off

​OFF

​Auto

​AUTO

boundingBoxCaching

name: boundingBoxCaching, type: Enum, default: AUTO

Values:

Title

Name

​On

​ON

​Off

​OFF

​Auto

​AUTO

renderCulling

name: renderCulling, type: Enum, default: AUTO

Values:

Title

Name

​On

​ON

​Off

​OFF

​Auto

​AUTO

pickCulling

name: pickCulling, type: Enum, default: AUTO

Values:

Title

Name

​On

​ON

​Off

​OFF

​Auto

​AUTO