Useful console commands

This page shows a table of useful console commands and what they are used for.

Open console command overlay

Press the ` key (backtick) shortcut
(often re-bound to the INSERT or HOME key)

This can be done at runtime.

Change keyboard shortcut

Open Edit → Project settings
Search for Engine → Input → Console
Edit key value

Changing the shortcut in the Editor's preferences will not be sufficient. The shortcut might not work in Live mode.

Setting console commands via the API

Use the ExecuteConsoleCommand Engine API - Call
Set the Command string to [Command] [value] for example r.PostProcessing.Log 1

Learn more about Using the Pixotope API

Setting console commands via the Control panel

Download an example control panel

Trigger a console command.pxpanel

or follow these steps:

Steps to setting console commands via the Control panel

Listen to any API log message
Add a widget using this action
Set this message to be a Trigger so it sends values
Update the Topic and the Message
- Update the Target and RespondTo machine names (Render1) with your machine names
- Update the command (r.depthoffieldquality)
- Update the value ({{value}})
  - Use a Dynamic Argument like above or a hard coded value

Topic

JSON

{
  "Type": "Call",
  "Target": "Render1-Engine",
  "RespondTo": "Render1-Director",
  "Method": "ExecuteConsoleCommand",
  "ID": "c68733f9-1ad6-45c0-ad15-3aa7acde6ca4"
}

Message

With dynamic argument

JSON

{
  "Params": {
    "Command": "r.depthoffieldquality {{value}}"
  }
}

With static value

JSON

{
  "Params": {
    "Command": "r.depthoffieldquality 2"
  }
}

Learn more about Triggering API calls from the Control panel

Pixotope console commands

Name	Description	Default
`Pixotope.ARSetExtension.ARDistortion`	Adds AR set extension delay compensation	`TRUE`
`Pixotope.ARSetExtension.FeatherDelayedProjection`
`Pixotope.CameraTracker.DisableNcamMapBackplane`	A redundant method to disable the backplane with NCAM MAP distortion `0` - Backplane included `1` - Backplane disabled	`1`
`Pixotope.CameraTracker.Overscan`	When greater than 0 the calculated overscan is multiplied by this, use if more overscan is needed.	`-1`
`Pixotope.CameraTracker.ResetStats`	Command to reset stats enabled by stat PixotopeCameraTrackerComponent to initial values.	`0`
`Pixotope.Compositing.RTShadows`	Use separate RT shadows map to avoid self shadows on catchers	`1`
`Pixotope.Compositing.LUTPosition`	When to apply LUT transformation. `0` - Before tonemapping `1` - After tonemapping `2` - After compositing (both scene and video will be affected)	`0`
`Pixotope.Compositing.AAMask`	Use AA on Mask	`TRUE`
`Pixotope.Compositing.ClearDLSSOnCameraSwitch`	ClearDLSSOnCameraSwitch	`TRUE`
`Pixotope.Compositing.DilateTranslucency`	Dilate the translucency texture to avoid outlines of AR objects with translucency.	`0`
`Pixotope.Compositing.DisableMBOnCameraSwitch`	DisableMBOnCameraSwitch	`TRUE`
`Pixotope.Compositing.DistortionUpscale`	Change the lens distortion filtering algorithm: `0` - Nearest `1` - Bilinear `2` - Catmull-Rom `3` - Lanczos	`1`
`Pixotope.Compositing.DistortionUpscaleLog`	Enable lens distortion filtering to be done in logarithmic color space `0` - Disabled `1` - Enabled	`0`
`Pixotope.Compositing.FilterLumenReflections`	Removes reflections where alpha is 0. Makes sense only with LumenReflectionAlpha.	`TRUE`
`Pixotope.Compositing.LumenReflectionAlpha`	Use Lumen Trace Hit as indicator what is and isnt reflection in reflection texture, by default reflection texture has no alpha and there is no difference between black reflection and no reflection.	`TRUE`
`Pixotope.Compositing.LumenReflectionAlphaBlur`	If LumenReflectionAlpha is active it add additional gaussina blur to smooth shimmering. Defines kernel size (0 - off)	`0`
`Pixotope.Compositing.LumenReflectionAlphaTAA`	If LumenReflectionAlpha is active it add additional TAA pass to smooth even further shimmering	`FALSE`
`Pixotope.Compositing.LumenReflectionsAlphaThreshold`	If LumenReflectionAlpha is active this will help to filer out (set alpha to 0) of far away objects from reflections	`10000`
`Pixotope.Compositing.LUTCorrectColor`	Correct colors before LUT color transform	`TRUE`
`Pixotope.Compositing.NonVolumetricPixoFog`	Allows enable depth bounds optimization on fog full screen pass.	`FALSE`
`Pixotope.Compositing.NoTonemapper`	NoTonemapper	`FALSE`
`Pixotope.Compositing.RemoveCatcherBehindPlane`	Removes catcher behind VS plane, use with AR+VS keyed scenarions	`FALSE`
`Pixotope.Compositing.ScaleDownForVideoCompositing`	Scale down scene to video resolution if necessary	`TRUE`
`Pixotope.Compositing.ScaleDownInOffline`	Scale down scene to video resolution when rendering offline movie	`FALSE`
`Pixotope.Compositing.SeparateShadowMask`	Use separate shadow mask rendering to avoid light function problems	`0`
`Pixotope.Compositing.TonemapOutsideCameraView`	Tonemap XR outside camera view	`TRUE`
`Pixotope.CTSReceiver.AllowCrosshair`	Allow seeing the crosshair when set to a `true` value, when `false` no crosshairs are allowed even if `Pixotope.CTSReceiver.EnableCrosshair` is `true` or Show Crosshair in Director is checked.	`1`
`Pixotope.CTSReceiver.EnableCrosshair`	Turn on crosshair for tuning decentering	`0`
`Pixotope.CTSReceiver.EnableDistortion`	Enable distortion	`1`
`Pixotope.CTSReceiver.EnableFocus`	Enable DOF `0` - Disabled `1` - Enabled	`1`
`Pixotope.FlushGPU`	Flush GPU in CTC	`FALSE`
`Pixotope.FrameMatcher.AllowInterpolation`	Replace missing packets with interpolation	`1`
`Pixotope.FrameMatcher.AllowReplacement`	Replace missing packets, detected using packet numbers. Either with copies or interpolated	`1`
`Pixotope.FrameMatcher.Method`	Overrides frame matching method set in Syncing panel. Use `FrameMatcher.Method ?` for more information.	`-1`
`Pixotope.HairStrands.UseCustomDepth`	Enable to mitigate the issue of hair being visible through a VS plane `0` - Disabled `1` - Enabled	`0`
`Pixotope.LUT.UseFloat`	Force use of float LUTs	`1`
`Pixotope.PrintCameraTracking`	Set to 1 to print incoming camera tracking packets in editor viewport	`0`
`r.depthoffieldquality`	Allows to adjust the depth of field quality. Currently only fully affects BokehDOF. GaussianDOF is either 0 for off, otherwise on. `0` - Off `1` - Low `2` - high quality (default, adaptive, can be 4x slower) `3` - very high quality, intended for non realtime cutscenes, CircleDOF only (slow) `4` - extremely high quality, intended for non realtime cutscenes, CircleDOF only (very slow)	`2`
`r.HairStrands.Visibility.UseCustomDepth`	Enable to mitigate the issue of hair being visible through a VS plane `0` - Disabled `1` - Enabled	`0`
`r.RayTracing.Culling`	Optimize what is visible outside of the current view and over what distance. Options to cull objects `0` - disabled `1` - behind the camera by distance and solid angle (default ray tracing culling method) `2` - in front of and behind the camera by distance and solid angle `3` - in front and behind the camera by distance or solid angle	`2`
`ShowFlag.DepthOfField`	Allows to override a specific showflag (works in editor and game, "show" only works in game and UI only in editor) Useful to run a build many time with the same showflags (when put in consolevariables.ini like "showflag.abc=0") `0` - force the showflag to be OFF `1` - force the showflag to be ON `2` - do not override this showflag (default)	`2`
`Stat PixotopeCameraTrackerComponent`	See camera tracker component stats
`Stat CTSreceiver`	CTSReceiver plugin stats must be called after `Stat PixotopeCameraTrackerComponent`
`DisableAllScreenMessages`	Disables all screen messages	`FALSE`