Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterDescriptionArgumentsExamples
#helpDisplays options for the vfbControl commandNone 
#showOpens (true) or closes (false) the VFB window or returns its current display state if called without a valueBoolean 

#rgb
#red
#green
#blue
#alpha
#mono

Enables/disables the corresponding VFB toolbar featureBooleanvfbControl #alpha true
#trackmouseEnables/disables the Track mouse while rendering featureBoolean 
#linkpdpEnables/disables the Link VFB to PDPlayer featureBoolean 
#swapabEnables/disables the Swap A/B featureBoolean 
#setcompareabEnables/disables Compare horizontal and Compare vertical features

"h" | "hor" | "horizontal"
"v" | "ver" | "vertical"

vfbControl #setcompareab "h"
#loadimageLoads the specified image in VFBString (filename) 
#saveimageSaves the VFB RGB color channel as an imageString (filename) 
#saveallimageSaves all VFB render channels to separate images or a single vrimg fileString (filename) 
#savemultiimageSaves a multichannel .exr or .vrimg file with all VFB render channels insideString (filename)vfbcontrol #savemultiimage "D:\output\image.exr"
#setregionSets the render region in pixels, or resets to entire image

Integers: left top right bottom
"reset" 

vfbControl #setregion 0 0 640 480
vfbControl #setregion "reset" 
#getregionReturns the current left, top, right, and bottom settings for region renderingNonevfbControl #getregion
#clearimageClears the VFB imageNone 
#duplicateDuplicates the VFBNone 
#hideHides the VFBNone 
#getchannelReturns the index of the currently selected render element channel.None 
#getchannelnamesReturns a list of the channels available in the current imageNone 
#setchannelSelects the render element channel with an indexIntegervfbControl #setchannel 0
#clamp

Enables/disables Force color clamping

BooleanvfbControl #clamp true
#viewclampEnables/disables View clamped colors Boolean 
#infoEnables/disables Show Pixel information Boolean 
#pixelaspectEnables/disables Use pixel aspectBoolean 
#srgb    
#stereoSets the Stereo value using an integer:
0 - Inactive
1 - Red/cyan mode
2 - Green/magenta mode
0 | 1 | 2vfbControl #stereo 1

...