Class SuperSourcePropertiesCommand

Base command type for a full writable command, which uses flags to indicate the changed properties

Hierarchy

WritableCommand<SuperSourceProperties & SuperSourceBorder>
- SuperSourcePropertiesCommand

Index

Constructors

constructor

new SuperSourcePropertiesCommand(): SuperSourcePropertiesCommand
Returns SuperSourcePropertiesCommand
Overrides WritableCommand.constructor
- Defined in src/commands/SuperSource/SuperSourcePropertiesCommand.ts:32

Properties

`Protected` _properties

_properties: Partial<SuperSourceProperties & SuperSourceBorder>

flag

flag: number

`Static` MaskFlags

MaskFlags: {
    artClip: number;
    artCutSource: number;
    artFillSource: number;
    artGain: number;
    artInvertKey: number;
    artOption: number;
    artPreMultiplied: number;
    borderBevel: number;
    borderBevelPosition: number;
    borderBevelSoftness: number;
    borderEnabled: number;
    borderHue: number;
    borderInnerSoftness: number;
    borderInnerWidth: number;
    borderLightSourceAltitude: number;
    borderLightSourceDirection: number;
    borderLuma: number;
    borderOuterSoftness: number;
    borderOuterWidth: number;
    borderSaturation: number;
} = ...

Type declaration

artClip: number
artCutSource: number
artFillSource: number
artGain: number
artInvertKey: number
artOption: number
artPreMultiplied: number
borderBevel: number
borderBevelPosition: number
borderBevelSoftness: number
borderEnabled: number
borderHue: number
borderInnerSoftness: number
borderInnerWidth: number
borderLightSourceAltitude: number
borderLightSourceDirection: number
borderLuma: number
borderOuterSoftness: number
borderOuterWidth: number
borderSaturation: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CSSc" = 'CSSc'

Accessors

properties

get properties(): Readonly<T>
Returns Readonly<T>
Inherited from WritableCommand.properties
- Defined in src/commands/CommandBase.ts:35

Methods

`Protected` _updateProps

_updateProps(newProps): boolean
Parameters
- newProps: {
  [key: string]: any;
  }
  - [key: string]: any
Returns boolean
Inherited from WritableCommand._updateProps
- Defined in src/commands/CommandBase.ts:63

serialize

serialize(): Buffer
Returns Buffer
Overrides WritableCommand.serialize
- Defined in src/commands/SuperSource/SuperSourcePropertiesCommand.ts:36

updateProps

updateProps(newProps): boolean
Update the values of some properties with this command
Parameters
- newProps: Partial<SuperSourceProperties & SuperSourceBorder>
Returns boolean
Inherited from WritableCommand.updateProps
- Defined in src/commands/CommandBase.ts:59

Class SuperSourcePropertiesCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SuperSourcePropertiesCommand

Properties

Protected _properties

flag

Static MaskFlags

Type declaration

artClip: number

artCutSource: number

artFillSource: number

artGain: number

artInvertKey: number

artOption: number

artPreMultiplied: number

borderBevel: number

borderBevelPosition: number

borderBevelSoftness: number

borderEnabled: number

borderHue: number

borderInnerSoftness: number

borderInnerWidth: number

borderLightSourceAltitude: number

borderLightSourceDirection: number

borderLuma: number

borderOuterSoftness: number

borderOuterWidth: number

borderSaturation: number

Static Optional Readonly minimumVersion

Static Readonly rawName

Accessors

properties

Returns Readonly<T>

Methods

Protected _updateProps

Parameters

newProps: { [key: string]: any; }

[key: string]: any

Returns boolean

serialize

Returns Buffer

updateProps

Parameters

newProps: Partial<SuperSourceProperties & SuperSourceBorder>

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Protected` _properties

`Static` MaskFlags

`Static` `Optional` `Readonly` minimumVersion

`Static` `Readonly` rawName

`Protected` _updateProps

newProps: {
[key: string]: any;
}