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.
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element