Standard ports

GrossGrade

Topic:  GrossGrade for Expert >

Standard ports

Previous page Parent topic Next page

 

Each component has a set of standard ports (that are identical for all components):

 

Click toggle to expand/collapse hidden blockInput ports

Port name

Port type

Used in components

Description

data

data

Components that use graphic data

Input graphic data. If the component can produce some color correction, it also has the output port "data".

c.func

coloring function

Components that use graphic data

Input coloring function. It could be used as a base for the output coloring function (output port "c.func.").

mask

weighting function

Components that use graphic data

Process mask - weighting function that determines the areas of color space which should be affected by color processing.

use mask

boolean

Components that use graphic data

Use process mask - the "True" value determines that process mask (port "mask") should be applied. If this port is not used (unplugged) then the mask is always applied.

apply channel

weight

(replicable)

Components that process graphic data

Apply factor for processing of the individual color channel of the current color space. It usually lies in the range from 0 to 1 but may be less than 0 and greater than 1. A particular color channel number is determined by the port instance number.

apply factor

weight

Components that process graphic data

Apply factor for color processing. It usually lies in the range from 0 to 1 but may be less than 0 and greater than 1.

visible

boolean

Visual components

Component visual part visibility (available for visual components only). On "False" value the visual part of the component is not used (hidden).

opacity

weight

Visual components

Opacity of the component visual part.

instancing

instancing

All

Component instancing. This port could be plugged to the instancing manager (see "InstancingManager").

reset

event()

(replicable)

All

Reset all current component settings to default values.

randomize

event( weight Amount )

(replicable)

All

Randomize all current component settings. "Amount" determines the randomization amount in the range from 0 to 1, where 0 means no effect, and 1 means maximum randomization.

enable

boolean

All

Component is active. On "False" value the component is not involved in the processing.

load file

event( string FileName )

(replicable)

All

Load content from file (for example a *.cube file to the component 3DLUT). File name is determined by parameter "FileName". This port is available in all components for loading the *.ggc file format. A specific file formats loading support depends on the particular component.

save file

event( string FileName )

(replicable)

All

Save content to file. File name is determined by parameter "FileName". This port is available in all components for saving the *.ggc file format. A specific file formats saving support depends on the particular component.

 

Click toggle to expand/collapse hidden blockOutput ports

Port name

Port type

Used in components

Description

data

data

Components that process graphic data

Output graphic data coming from the input port "data" and processed by the component.

c.func.

coloring function

Components that process graphic data

Output coloring function. The port generates the color correction that the component produce. If the input port "c.func" is plugged, then the input coloring function is used as a base.

colorspace

string

Components that use graphic data

The name of the internal color space used in the component.

changed

event()

Components that notify on changes

Notify event when the user has changed some of the current component settings.

id

enum

All

Unique ID of the component. Could be used as a link from the other components.