Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ColorCorrectionEffect

Adjusts color-related properties of the rendered world like saturation, tint, brightness, and contrast.

Memory categoryInstances

Member index 4

HistoryMember
553Brightness: float
553Contrast: float
553Saturation: float
553TintColor: Color3
inherited from PostEffect
553Enabled: bool
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 1

HistoryMember
631TonemapperPreset: TonemapperPreset

Description

ColorCorrectionEffect can be used to adjust several color-related properties at once, including Saturation, TintColor, Brightness and Contrast. It's useful for fine-tuning the visual aesthetic of a world or communicating status effects to the player. Multiple ColorCorrectionEffect objects can be applied at the same time and they will compose their effects together.

Like other post-processing effects, ColorCorrectionEffect will only work while Enabled and when parented to Lighting or Workspace.CurrentCamera. Also, it may render differently depending on your Studio settings (see Editor Quality Level in Rendering).

History 19

Members 4

Brightness

TypeDefault
float0

This property determines by how much the colors of pixels will be shifted. A value of -1 will cause all pixels to be completely black while a value of 1 will cause them to be white.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

Contrast

TypeDefault
float0

This property determines the separation between the dark and light colors. Values less than 0 have reduced contrast while values greater than 0 have increased contrast.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

Saturation

TypeDefault
float0

This property determines the change in intensity of pixel colors. Values above 1 will cause colors to be more vivid while values below 0 will make colors more dull, eventually reaching full desaturation at -1.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

TintColor

TypeDefault
Color31, 1, 1

This property determines by what factors the RGB channels of pixel colors are scaled. The effect is multiplicative, so changing this to [255, 0, 0] (red) would cause the green and blue channels to be multiplied by 0.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

Removed members 1

TonemapperPreset

TypeDefault
TonemapperPresetDefault
This property is not scriptable. It cannot be accessed by script code.
Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 2

Tags: [NotScriptable]

Settings