LightModulatorclass
Filters direct light passing through a textured rectangle or infinite plane in the local Y/Z plane. This changes lighting on receivers; add a separate renderer to display the glass itself.
Constructors1
Showing 1 constructors
public LightModulator()
No results match this filter.
Properties44
Showing 44 properties
public Sandbox.LightModulator.ModulationBlendMode Sandbox.LightModulator.BlendMode { get; set; }
Multiply applies the texture directly; Lighten only boosts light and Darken only reduces it. Applied per RGB channel after contrast, brightness and tint, before strength and alpha.
public float Sandbox.LightModulator.Brightness { get; set; }
Linear brightness multiplier after contrast. One preserves brightness; values above one boost light. Alpha is unaffected. This is an artistic light multiplier, not physical light focusing.
float—public float Sandbox.LightModulator.CausticsLayerScale { get; set; }
Scale of the second caustic sample relative to the first.
float—public float Sandbox.LightModulator.CausticsSpeed { get; set; }
Animation speed multiplier. Zero freezes caustic motion; negative values reverse it.
float—public float Sandbox.LightModulator.CausticsTimeOffset { get; set; }
Offset in caustic animation time, in seconds at the default speed.
float—public float Sandbox.LightModulator.CausticsWobble { get; set; }
Maximum UV displacement in texture repeats.
float—public float Sandbox.LightModulator.ChromaticSplitSeparation { get; set; }
UV offset in texture repeats for the red and blue samples on either side of green.
float—public float Sandbox.LightModulator.ChromaticSplitSpeed { get; set; }
Rotation speed of the red/blue separation direction in radians per second.
float—public float Sandbox.LightModulator.ChromaticSplitTimeOffset { get; set; }
Offset in chromatic split animation time, in seconds at the default speed.
float—public float Sandbox.LightModulator.CloudShadowDepth { get; set; }
Blend from white transmission at zero to the full cloud texture at one, before colour adjustments.
float—public float Sandbox.LightModulator.CloudShadowLayerScale { get; set; }
Scale of the second cloud sample relative to the first.
float—public float Sandbox.LightModulator.CloudShadowSpeed { get; set; }
Cloud drift speed multiplier. Zero freezes the clouds; negative values reverse them.
float—public float Sandbox.LightModulator.CloudShadowTimeOffset { get; set; }
Offset in cloud animation time, in seconds at the default speed.
float—public float Sandbox.LightModulator.Contrast { get; set; }
RGB contrast around linear 0.5, before brightness and tint. One preserves the texture. Alpha is unaffected; negative RGB results are clamped to zero.
float—public float Sandbox.LightModulator.DistanceFeather { get; set; }
Fade in modulation over this many world units from the rectangle's plane. Uses perpendicular distance for both surfaces and fog, independent of light angle or object scale. Zero disables distance feathering; full strength is reached at this distance and beyond.
float—public float Sandbox.LightModulator.DistanceMipBias { get; set; }
Softens transmission as light travels from the glass to the receiving surface or fog sample. Adds this many mip levels at 128 world units, twice as many at 384 units. Zero disables distance softening.
float—public float Sandbox.LightModulator.EdgeFeather { get; set; }
Fade inward from each rectangle edge, as a fraction of its width or height. Zero gives a hard boundary; 0.1 fades across the outer ten percent on each axis. Uses the physical rectangle, independent of texture tiling or scrolling.
float—public Sandbox.LightModulator.ModulationEffect Sandbox.LightModulator.Effect { get; set; }
Animate the projected texture before contrast, brightness, tint and blending. None preserves the existing texture mapping.
public bool Sandbox.LightModulator.Infinite { get; set; }
Extend the rectangle to an infinite plane, without aperture clipping or edge feathering. Sidedness and distance feathering still apply.
bool—public float Sandbox.LightModulator.KaleidoscopeBlend { get; set; }
Blend from the original UV mapping at zero to fully mirrored sectors at one.
float—public int Sandbox.LightModulator.KaleidoscopeSegments { get; set; }
Number of mirrored sectors around the center of the texture.
int—public float Sandbox.LightModulator.KaleidoscopeSpeed { get; set; }
Rotation speed of the mirrored pattern in degrees per second.
float—public float Sandbox.LightModulator.KaleidoscopeTimeOffset { get; set; }
Offset in kaleidoscope animation time, in seconds at the default speed.
float—public float Sandbox.LightModulator.MipLevel { get; set; }
Explicit texture mip used by divergent light queries; larger values soften the projection.
float—public Vector2 Sandbox.LightModulator.Offset { get; set; }
Texture-coordinate offset in repeats, applied after tiling and rotation.
public float Sandbox.LightModulator.PulseDepth { get; set; }
Brightness variation, from constant brightness at zero to a full zero-to-one pulse at one.
float—public float Sandbox.LightModulator.PulseSharpness { get; set; }
Shape of the brightness pulse. One gives a sine wave; higher values narrow the bright interval.
float—public float Sandbox.LightModulator.PulseSpeed { get; set; }
Brightness cycles per second. Zero freezes the pulse; negative values reverse it.
float—public float Sandbox.LightModulator.PulseTimeOffset { get; set; }
Offset in pulse animation time, in seconds at the default speed.
float—public float Sandbox.LightModulator.RippleDisplacement { get; set; }
Maximum radial UV displacement in texture repeats.
float—public float Sandbox.LightModulator.RippleFrequency { get; set; }
Radial wave frequency multiplier. Higher values produce more closely spaced waves.
float—public float Sandbox.LightModulator.RippleSpeed { get; set; }
Wave animation speed multiplier. Zero freezes the ripples; negative values reverse them.
float—public float Sandbox.LightModulator.RippleTimeOffset { get; set; }
Offset in ripple animation time, in seconds at the default speed.
float—public float Sandbox.LightModulator.RotationSpeed { get; set; }
Clockwise rotation speed in degrees per second. Negative values rotate counterclockwise.
float—public float Sandbox.LightModulator.RotationTimeOffset { get; set; }
Offset in rotation animation time, in seconds at the default speed.
float—public Vector2 Sandbox.LightModulator.ScrollSpeed { get; set; }
Scroll effect movement in repeats per second along U and V. Zero leaves the projection still. Runs in the shader without rebuilding textures or light candidate lists each frame.
public Vector2 Sandbox.LightModulator.Size { get; set; }
Rectangle width along local Y and height along local Z, before object scaling. For an infinite plane, this is the UV reference size when World Sized UVs is disabled.
public float Sandbox.LightModulator.Strength { get; set; }
Blend between original light at zero and full texture modulation at one. Multiplies texture alpha and edge feathering rather than dimming the light itself.
float—public Sandbox.Texture Sandbox.LightModulator.Texture { get; set; }
RGB transmission through the rectangle. Alpha blends between unfiltered and filtered light. Sampling uses the texture's own colour space.
public float Sandbox.LightModulator.TextureRotation { get; set; }
Clockwise rotation of the projected texture in degrees, around its center.
float—public Vector2 Sandbox.LightModulator.Tiling { get; set; }
Texture repeats across the rectangle, or per 128 world units with World Sized UVs enabled. Negative values mirror the texture. Scaling and rotation are centered on the rectangle.
public Color Sandbox.LightModulator.Tint { get; set; }
Linear RGB multiplier, including values above one for artistic caustics.
public bool Sandbox.LightModulator.TwoSided { get; set; }
Applies the filter in both directions. Otherwise light travels along local positive X only.
bool—public bool Sandbox.LightModulator.WorldSizedUVs { get; set; }
Keep texture density independent of rectangle size and object scale. Tiling specifies repeats per 128 world units along the plane's axes, centered on its origin.
bool—No results match this filter.