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
#pos

Controls the position of the  VFB window:
<top> - the vertical coordinates of the VFB window
<left> - the horizontal coordinates of the VFBwindow
"reset" - returns the VFB window to its default position
Note: Running without any arguments will return the current position of the VFB window.

Integers: top left
"reset"

vfbControl #pos 100 150
vfbControl #pos "reset"

 

VFB Color Correction Options

ParameterDescriptionArgumentsExamples
#showccShows/hides the Color Corrections panelBoolean 
#exposure

Enables/disables Exposure correction

Boolean 
#whitebalanceEnables/disables White Balance correctionBoolean 
#huesatEnables/disables Hue / Saturation correctionBoolean 
#colorbalanceEnables/disables Color Balance correctionBoolean 
#levelsEnables/disables Levels correctionBoolean 
#curveEnables/disables Curve correctionBoolean 
#bkgrEnables/disables Background Image correctionBoolean 
#lutEnables/disables LUT correctionBoolean 
#ocioEnables/disables OCIO correctionBoolean 
#iccEnables/disables ICC correctionBoolean 
#srgbEnables/disables sRGB gamma correctionBoolean 
#ccociovtSets OCIO View Transform by number in the dropdown listInteger 
#ccocioicsSets OCIO Input Colorspace by number in the dropdown listInteger 
#ccocioddSets OCIO Display Device by number in the dropdown listInteger 
#ocioinputcolorspaceSets OCIO Input Colorspace by nameString 
#ociodisplaydeviceSets OCIO Display Device by nameString 
#ocioviewtransformSets OCIO View Transform by nameString 
#itemsociocsReturns a list of all available OCIO Input Colorspace valuesNone 
#itemsocioddReturns a list of all available OCIO Display Device valuesNone 
#itemsociovtReturns a list of all available OCIO View Transform valuesNone 
#itemsiccriReturns a list of all available ICC Rendering Intent valuesNone 
#colorbalancemode

Sets the Color Balance mode with an integer:
0 - All
1 - Shadows
2 - Midtones
3 - Highlights

0 | 1 | 2 | 3vfbControl #colorbalancemode 3
#colorbalancevalueSets the Color Balance values
for Cyan, Magenta, Yellow
# # #
Where each # is an
integer or float
vfbControl #colorbalancevalue 0.2 0 0.1
#huesaturationvalueSets the Hue/Saturation values
for
Hue, Saturation, Brightness
# # #
Where each # is an
integer or float
 
#cclevels_rgb
#cclevels_red
#cclevels_green
#cclevels_blue
Enables/disables color components in Levels correctionBoolean 
#bkgrimgasforegrEnables/disables the use of Background correction image as foregroundBoolean 
#lutconverttologEnables/disables Log space conversion before applying LUTBoolean 
#cciccblackpointEnables/disables ICC black point compressionBoolean 
#cciccrenderintent1 - Perceptual 
2 - Relative colorimetric
3 - Saturation
4 - Absolute colorimetric
1 | 2 | 3 | 4 

#setexposure

Sets Exposure value Float 
#setcontrastSets Contrast value Float 
#setlevelsminSets Levels min valueFloat 
#setlevelsmaxSets Levels max valueFloat 
#setwhitebalancevalSets White Balance Temperature valueFloat 
#getexposureReturns the current Exposure float value None 
#getcontrastReturns the current Contrast float value None 
#getlevelsminReturns the current Levels min float valueNone 
#getlevelsmaxReturns the current Levels max float valueNone 
#getwhitebalancevalReturns the current White Balance Temperature float valueNone 
#loadbkgrimageSpecifies file for Background image correctionString (filename) 
#loadlutSpecifies file for LUT correctionString (filename) 
#loadocioSpecifies file for OCIO correctionString (filename) 
#loadiccSpecifies file for ICC correctionString (filename) 
#loadcurveLoad Curve shape from the specified .bcurve file String (filename) 
#savecurveSave Curve shape in the specified .bcurve fileString (filename) 
#saveglobalccpreset



Save Global preset for the Corrections control panel to a specified .vccglb file


String (filename) 
#loadglobalccpresetLoad Global preset for the Corrections control panel from a specified .vccglb fileString (filename) 
#saveccpresetSave preset for corrections control rollout to a specified file.
Presets for each separate Correction control rollout use different file extensions.
String (filename) 
#loadccpresetLoad preset in corrections control rollout from a specified file.
Presets for each separate Correction control rollout use different file extensions.
String (filename) 
#resetcc
#resetccexp
#resetccwb
#resetcchsl
#resetccbal
#resetcclvl
#resetcccrv
#resetcclut
#resetccicc
#resetccocio
#resetccbgimg
Resets parameters from corresponding
Correction Control rollouts to default values.
Nonevfbcontrol #resetcc - Resets all correction control parameters
vfbcontrol #resetccbal - Resets only parameters in Color Balance rollout

#bkgrimgfile
#lutfile
#iccfile
#ociofile

Returns the filename (string) used in the corresponding Correction Control rolloutNone 

...