Module

Base class: Resource

Subclasses: AnimateCamera, AnimateCamera2, AnimationModule, AudioModule, BitmapMoveModule, BugsModule, CameraControlModule, ComposeModule, ControlModule, DVIMatrixControlModule, DmxControlModule, DmxShareModule, ExpressionVariablesModule, FadeModule, GradientModule, HttpControlModule, IgnoreTimecodeModule, IndirectionControl, MDCModule, MasterModule, MidiNoteModule, MtcModule, NotchModule, OpenModule, OscControlModule, PixelMapModule, PlayModeModule, PongModule, ProjectionAwareModule, ProjectorControlModule, Radar, RadarModule, ScanModule, ScreenPositionModule, ScrollModule, SpinBitmap, StageRenderModule, StrobeModule, SuperResolutionModule, Target2Module, TargetModule, TargetObjectModule, TestPatternModule, TextModule, TimecodeReadoutModule, TrackJumpModule, TrackModule, TrackingMarkerModule, TransportBrightnessLocalModule, TransportControlModule, TransportVolumeLocalModule, TriggerModule, TwoPoint5DModule, WebModule

Properties

blendMode : int

Controls how the module composites its output with layers below it

brightness : float

Controls the brightness of the module. If the module is on alpha mode then zero brightness means fully transparent

canvas : DxTexture (Read-Only)

canvasSize : Vec2 (Read-Only)

colour : Colour (Read-Only)

forceTint : Colour

isExternalControl : bool (Read-Only)

isGraphical : bool (Read-Only)

isInternalControl : bool (Read-Only)

isRendering : bool (Read-Only)

layer : Layer (Read-Only)

mapping : Projection

Controls which screens receive the content of the module and the mapping technique used

moduleConfigObject : ModuleConfig (Read-Only)

needsPreview : bool (Read-Only)

ocioInputSpace : OcioColourSpace (Read-Only)

ownCanvas : bool (Read-Only)

palette : DxTexture

Bitmap from which palette colours (tints) are read

tint : Colour

xCol : float

Horizontal lookup position within the palette. 0 is left, 1 is right

yCol : float

Vertical lookup position within the palette. 0 is top, 1 is bottom

Methods

defaultResourceSequence(self) -> str

getPersonality(self) -> SockpuppetPersonality

nSourceModules(self) -> int

renderPreview(self, drawRect: Rect, colour: Colour, showAlpha: bool, inGuiColourSpace: bool)

resourceDuration(self, sequenceName: str) -> float

resourceDurationDescription(self, sequenceName: str) -> str

sourceName(self, i: int) -> str