Show / Hide Table of Contents

Struct OldMovieConfiguration

Creates the effect of an old movie reel / projector Includes: Scratch Lines in frames, Noise, Random Vertical Shifting, Dimming, Reel Rolling, Over Exposure Flicker

Inherited Members
ValueType.Equals(object)
ValueType.GetHashCode()
ValueType.ToString()
object.GetType()
object.Equals(object, object)
object.ReferenceEquals(object, object)
Namespace: Yak2D
Assembly: Yak2D.Api.dll
Syntax
public struct OldMovieConfiguration

Properties

Dim

Scalar for random dimming amount

Declaration
public float Dim { readonly get; set; }
Property Value
Type Description
float

Intensity

Used for twice:

  1. An interpolation between unmodified texture coordinates and modified. 1.0 resulting in max pixellation
  2. Interpolation between pre- effect and post-effect pixels (0 to 1)
Declaration
public float Intensity { readonly get; set; }
Property Value
Type Description
float

Noise

Scalar for Noise

Declaration
public float Noise { readonly get; set; }
Property Value
Type Description
float

OverExposureFlickerTimeMax

Maximum time for over exposure flicker duration. Duration chosen randomly in range

Declaration
public float OverExposureFlickerTimeMax { readonly get; set; }
Property Value
Type Description
float

OverExposureFlickerTimeMin

Minimum time for over exposure flicker duration. Duration chosen randomly in range

Declaration
public float OverExposureFlickerTimeMin { readonly get; set; }
Property Value
Type Description
float

OverExposureIntensityMax

Maximum Over Exposure Intensity. Intensity chosen randomly in range

Declaration
public float OverExposureIntensityMax { readonly get; set; }
Property Value
Type Description
float

OverExposureIntensityMin

Minimum Over Exposure Intensity. Intensity chosen randomly in range

Declaration
public float OverExposureIntensityMin { readonly get; set; }
Property Value
Type Description
float

OverExposureOscillationsMax

Maximum number of over exposure oscillations per flicker. Number of chosen randomly in range

Declaration
public float OverExposureOscillationsMax { readonly get; set; }
Property Value
Type Description
float

OverExposureOscillationsMin

Minimum number of over exposure oscillations per flicker. Number of chosen randomly in range

Declaration
public float OverExposureOscillationsMin { readonly get; set; }
Property Value
Type Description
float

OverExposureProbabilityStart

Chance over exposure flicker starts each frame (lower less likely)

Declaration
public float OverExposureProbabilityStart { readonly get; set; }
Property Value
Type Description
float

ProbabilityRollEnds

Chance a reel roll stops each frame when rolling (lower less likley)

Declaration
public float ProbabilityRollEnds { readonly get; set; }
Property Value
Type Description
float

ProbabilityRollStarts

Chance a reel roll starts each frame (lower less likley)

Declaration
public float ProbabilityRollStarts { readonly get; set; }
Property Value
Type Description
float

RndShiftCutOff

Random cut off factor for shifting screen vertically at random intervals A higher value makes random shifts less likely

Declaration
public float RndShiftCutOff { readonly get; set; }
Property Value
Type Description
float

RndShiftScalar

The intensity of random shift movement

Declaration
public float RndShiftScalar { readonly get; set; }
Property Value
Type Description
float

RollAccelerationMax

Max reel roll texture coordinte acceleration. Acceleration is chosen randomly in interval

Declaration
public float RollAccelerationMax { readonly get; set; }
Property Value
Type Description
float

RollAccelerationMin

Min reel roll texture coordinte acceleration. Acceleration is chosen randomly in interval

Declaration
public float RollAccelerationMin { readonly get; set; }
Property Value
Type Description
float

RollOverallScale

Linear scaler to modify overal roll movement

Declaration
public float RollOverallScale { readonly get; set; }
Property Value
Type Description
float

RollShakeFactor

Scales the amount of random shaking in the texture coordinate shifting of the reel rolls

Declaration
public float RollShakeFactor { readonly get; set; }
Property Value
Type Description
float

RollSpeedMax

Max reel roll texture coordinte speed. Speed is chosen randomly in interval

Declaration
public float RollSpeedMax { readonly get; set; }
Property Value
Type Description
float

RollSpeedMin

Min reel roll texture coordinte speed. Speed is chosen randomly in interval

Declaration
public float RollSpeedMin { readonly get; set; }
Property Value
Type Description
float

Scratch

Scalar for amount of scratch lines

Declaration
public float Scratch { readonly get; set; }
Property Value
Type Description
float

Methods

GenerateDefault()

Generate a Default Configurations for the Old Movie Effect

Declaration
public static OldMovieConfiguration GenerateDefault()
Returns
Type Description
OldMovieConfiguration

PreSet(float)

Returns a pre-set effect configuration scaled between 0 and 1

Declaration
public static OldMovieConfiguration PreSet(float amount)
Parameters
Type Name Description
float amount

0 to 1 intensity of effect

Returns
Type Description
OldMovieConfiguration
In this article
Back to top yak2D - Alex Paterson