Render Effects Profile

Render Effects Profiles store a variety of settings that affect how a scene is rendered. The main advantage of render effects profiles is that they make it easy to load presets into a camera. Use FxCamera to load and save profiles.

Properties

Name	Type	Default	Access	Description
aaEnable	1b	true	🟩🟥	Enable anti-aliasing
aoEnable	1b	true	🟩🟥	Enable ambient occlusion
aoIntensity	1f	5.0	🟩🟥	Ambient occlusion intensity
aoRadius	1f	2.0	🟩🟥	Ambient occlusion radius
bloomEnable	1b	false	🟩🟥	Enable bloom
bloomIntensity	1f	1.0	🟩🟥	Bloom intensity
bloomThreshold	1f	1.0	🟩🟥	Bloom threshold
caEnable	1b	false	🟩🟥	Enable chromatic abberation
caIntensity	1f	0.5	🟩🟥	Chromatic abberation intensity
caShift	2f	(2.5, -0.5)	🟩🟥	Chromatic abberation shift
ccEnable	1b	false	🟩🟥	Enable color correction
ccBrightness	1f	0.0	🟩🟥	Color correction brightness shift
ccContrast	1f	0.0	🟩🟥	Color correction contrast shift
ccHue	1f	0.0	🟩🟥	Color correction hue shift
ccSaturation	1f	0.0	🟩🟥	Color correction saturation shift
ccTintColor	1c	0xFFFF0000	🟩🟥	Color correction tint color
ccTintIntensity	1f	0.0	🟩🟥	Color correction tint i
cgEnable	1b	false	🟩🟥	Enable color grading
cgLutContribution	1f	1.0	🟩🟥	Color grading lookup table contribution
cgLutFile	1s	"default"	🟩🟥	Color grading lookup table LUT FileID (no list, wildcard or filter)
distortEnable	1b	false	🟩🟥	Enable distortion
distortX	1f	0.5	🟩🟥	Horizontal distortion
distortY	1f	0.5	🟩🟥	Vertical distortion
dofEnable	1b	false	🟩🟥	Enable depth of field
dofFocalLength	1f	12.0	🟩🟥	Depth of field focal length
dofFocusDistance	1f	50.0	🟩🟥	Depth of field docus distance
dofFStop	1f	5.6	🟩🟥	Depth of field F-stop
exposure	1f	1.0	🟩🟥	Color correction exposure multiplier
fisheyeEnable	1b	false	🟩🟥	Enable fisheye lens
fisheyeIntensity	1f	0.2	🟩🟥	Fisheye intensity
fogColor	1c	0xffffffff	🟩🟥	Fog color
fogDensity	1f	0.5	🟩🟥	Fog density
fogEnable	1b	false	🟩🟥	Enable fog
gamma	1f	2.2	🟩🟥	Gamma correction
grainIntensity	1f	12.0	🟩🟥	Grain intensity
grainEnable	1b	false	🟩🟥	Enable grain
grainStatic	1b	false	🟩🟥	Whether grain changes every frame
lensFlareEnable	1b	false	🟩🟥	Enable lens flare
lensTextureEnable	1b	false	🟩🟥	Enable lens texture
lensTextureFile	1s	"default"	🟩🟥	Lens Texture FileID (no list, wildcard or filter)
lensTextureFilter	1i	1	🟩🟥	TextureFilter
letterBoxEnable	1b	false	🟩🟥	Enable letter box
letterBoxSize	1f	0.1	🟩🟥	Letter box size
overlayAlign	1i	0	🟩🟥	Overlay texture alignment RectAlign
overlayEnable	1b	false	🟩🟥	Enable overlay
overlayFile	1s	"default"	🟩🟥	Overlay Texture FileID (no list, wildcard or filter)
overlayOffset	2i	(0, 0)	🟩🟥	Overlay texture offset
overlayOpacity	1f	1.0	🟩🟥	Overlay texture opacity
sharpenEnable	1b	false	🟩🟥	Enable sharpen
sharpenIntensity	1f	0.4	🟩🟥	Sharpen intensity
toneMapping	1i	0	🟩🟥	ToneMapping algorithm
vignetteEnable	1b	false	🟩🟥	Enable vignette
vignetteIntensity	1f	1.0	🟩🟥	Vignette intensity
vignetteSize	1f	0.5	🟩🟥	Vignette size

Details

Type
1b: boolean
1c: color (integer)
1i: integer
1f: float
1s: string
2b: 2-component boolean vector
2i: 2-component integer vector
2f: 2-component float vector
3b: 3-component boolean vector
3i: 3-component integer vector
3f: 3-component float vector

Access
🟩 : Property value can be read with FxFile.Get
🟥 : Property value can be changed with FxFile.Set
❌ : Property value is read-only and can't be changed

Create

To create a new render effects profile use FxFile.Create with FileType 556.

profileID = FxFile.Create(556);
profileID = FxFile.Rename(556, profileID, "MyProfile"); -- rename new profile
FxFile.Open(556, profileID); -- open new profile

Files

The global render effects profile is located at documents\Foxel\default.fxlrfx. It saves the settings of the main editing viewport. Other custom profiles are saved as shared files in Shared\Profile\RenderEffects\ with the extension .fxlrfx.