instantreality 1.0

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

ImageGrabOverlay

Defines a single overlay for grabbing the framebuffer content into a texture. Overlays can only be used as parts/ children of a Foreground node. Use a Foreground node to group overlays.

Inheritance

Code

XML encoding
<ImageGrabOverlay image='0 0 0'
frameLag='0'
autoResize='TRUE'
triggerName='Render'
enabled='TRUE'
exclusive='FALSE'
logFeature=''
 />
Classic encoding
ImageGrabOverlay {
	image 0 0 0
	frameLag 0
	autoResize TRUE
	triggerName "Render"
	enabled TRUE
	exclusive FALSE
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
SFImage image SFImage inputOutput 0 0 0 The image to grab into.
SFNode sourceTexture SFNode inputOutput SingleTexture The source texture to grab. If empty, backbuffer is grabbed.
SFInt32 frameLag SFInt32 inputOutput 0 [0, inf) Number of frames the grabber should lag behind.Can reduce coupling between CPU and GPU and lead to higher frame rates (but the grabbed image will contain the values of frameLag frames ago).2 is a good value.
SFBool autoResize SFBool inputOutput TRUE Automatically resize the image when the viewport size changes.
SFString triggerName SFString initializeOnly Render Name of the dynamic context slot, which is used by the run-time environment (e.g. Jobs) to trigger the node. Life nodes will automatically connect the context eventOutput to the triggerSlot eventInput slot.
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
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
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element