Class TextModeCRTVolume

Shows a camera's picture through a simulated cathode ray tube. Add it to a Volume profile; the TextModeCRTRendererFeature on the URP renderer draws it.

Inheritance

object

Object

ScriptableObject

VolumeComponent

TextModeCRTVolume

Implements

IApplyRevertPropertyContextMenuItemProvider

IPostProcessComponent

Inherited Members

VolumeComponent.active

VolumeComponent.TryGetRevertMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceTerm()

VolumeComponent.TryGetApplyMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceName(Component)

VolumeComponent.Override(VolumeComponent, float)

VolumeComponent.SetAllOverridesTo(bool)

VolumeComponent.AnyPropertiesIsOverridden()

VolumeComponent.GetStateHash()

VolumeComponent.Release()

VolumeComponent.parameters

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetEntityId()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsByType(Type)

Object.FindObjectsByType(Type, FindObjectsInactive)

Object.DontDestroyOnLoad(Object)

Object.FindAnyObjectByType<T>()

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsByType<T>()

Object.FindObjectsByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType(Type)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Scylla.TextMode.URP

Assembly: ScyllaTextMode.URP.dll

Syntax

[Serializable]
[VolumeComponentMenu("Scylla/TextMode CRT")]
[SupportedOnRenderPipeline(typeof(UniversalRenderPipelineAsset))]
public sealed class TextModeCRTVolume : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent

Remarks

The effect is off until Enable is set, like the other Volume effects. The look comes from a TextModeCRTPreset; without one the default preset is used. Volumes blend nothing between presets: the preset of the highest-priority Volume that sets one wins.

This component only holds the settings. Nothing is drawn unless the active URP renderer has a TextModeCRTRendererFeature and the TextMode module is running. The feature reads the Volume stack of the camera that is rendering, so the Volume's mode (global or local) and layer mask decide which cameras show the CRT. In a camera stack the Volume path draws only on the camera that resolves the final target. A camera that was shown from code through TextModeCRTCameraEffects ignores this component and uses the settings it was given.

Under HDR output the light is handled as described on TextModeCRTRendererFeature, and the injection point is chosen there.

To set it up in the Editor, follow these steps.

1. Run the menu item Tools/Scylla/TextMode/Add CRT to URP Renderers, or add a TextMode CRT renderer feature to the URP renderer asset by hand.
2. Add a Volume to the scene and give it a Volume profile.
3. Choose Add Override, then Scylla, then TextMode CRT.
4. Tick Enable, then pick a preset, a quality tier and, if wanted, a source line count.

The same setup from code, for a Volume profile that already exists.

if (profile.TryGet(out TextModeCRTVolume crt))
{
    crt.Enable.Override(true);
    crt.QualityTier.Override(CRTQualityTier.High);
    crt.SourceLines.Override(240);
}

Fields

Enable

Switches the CRT on for cameras inside this Volume. While this is off, or not overridden, the component does nothing.

Declaration

public BoolParameter Enable

Field Value

Type	Description
BoolParameter

Preset

The TextModeCRTPreset that describes the monitor to simulate. Empty uses the default preset from the TextMode configuration. If no default preset exists either, nothing is drawn.

Declaration

public TextModeCRTPresetParameter Preset

Field Value

Type	Description
TextModeCRTPresetParameter

QualityTier

Quality of the simulation. Low is a single pass, Medium adds afterglow and glow, High adds halation and a beam width per color channel. The default is Medium.

Declaration

public CRTQualityTierParameter QualityTier

Field Value

Type	Description
CRTQualityTierParameter

ReadabilityClamp

Limits the settings that cost legibility: softness, curvature, glow and afterglow. Turn it on when text on the screen has to stay easy to read.

Declaration

public BoolParameter ReadabilityClamp

Field Value

Type	Description
BoolParameter

SourceLines

A fixed number of scanlines for a low-resolution look, such as 240. The picture is scaled down to that many lines before it is drawn. 0 derives the count from the preset's scanline pitch and keeps the camera's resolution.

Declaration

public ClampedIntParameter SourceLines

Field Value

Type	Description
ClampedIntParameter

Methods

IsActive()

Gets whether the effect should be drawn. URP calls this through UnityEngine.Rendering.IPostProcessComponent, and the renderer feature calls it to decide whether a camera needs the CRT pass at all.

Declaration

public bool IsActive()

Returns

Type	Description
bool	True when Enable is set.

Implements

UnityEditor.IApplyRevertPropertyContextMenuItemProvider

UnityEngine.Rendering.IPostProcessComponent