instantreality 1.0

Component:
EnvironmentalEffects
Status:
fully implemented
Structure type:
concrete
Standard:
Avalon

FBOOverlay

Wraps another overlay to let it render into a texture.

Inheritance

Code

XML encoding
<FBOOverlay targetTexturesResizeMode='NONE'
deactivateViewport='FALSE'
overrideViewport='0 0 0 0'
enabled='TRUE'
exclusive='FALSE'
logFeature=''
 />
Classic encoding
FBOOverlay {
	targetTexturesResizeMode "NONE"
	deactivateViewport FALSE
	overrideViewport 0 0 0 0
	enabled TRUE
	exclusive FALSE
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
MFNode targetTextures MFNode inputOutput SingleTexture The textures to render to. Hint: Use a SolidTexture.
MFString logFeature MFString inputOutput state, child, parent, route, eventIn, eventOut controls the logging of changes, state: log state changes (e.g. live), child: log child add/remove, parent: log parent add/remove, route: log route add/remove; eventIn: log receiving of events, eventOut: log sending of events: guiView, runtime system should create node-view, guiEdit: runtime system should create node-editeverything: log everything
SFBool deactivateViewport SFBool inputOutput FALSE If true, the underlying OSGViewport is deactivated before rendering the overlay (and then activated again). Only use this if you know what you're doing. You probably don't!
SFBool enabled SFBool inputOutput TRUE flag to enable/disable the overlay
SFBool exclusive SFBool inputOutput FALSE defines if the overlay should be exclusive visible or not
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element
SFNode overlay SFNode inputOutput Overlay The overlay to render.
SFString targetTexturesResizeMode SFString inputOutput NONE NONE: don't resize; WINDOW: resize to window (backbuffer) size; VIEWAREA: resize to viewarea (viewport) size.
SFVec4f overrideViewport SFVec4f inputOutput 0 0 0 0 Can be used to override viewport settings. Mainly useful to automatically span a viewport over the whole target. 0 0 0 0 means don't change (default); -1 -1 -1 -1 means stretch to whole target texture; Otherwise glViewport is called with the values as parameters (left, bottom, width, height; rounded to int).