Skip to content

Layer Requirements

This is a very powerful feature, which allows effect designers to specify the requirements for their effects, under which they perform the best.

Tip

You can check all effect requirements in the Extension Settings window.

Layer Requirement Attributes

Each effect can define requirements via layer requirement class attributes. For more information read the extension SDK documentation.

Available Requirements

Currently, the following requirements can be defined. Each requirement can be combined with other requirements as well (see examples below).

Warning

Duplicate requirements will override each other. For example, defining a minimum width requirement for a second time will cause an override of its first definition by the second definition.

Dimensions

Minimum Width

The project width has to be greater than or equal to given minimum width.

Maximum Width

The project width has to be less than or equal to given maximum width.

Minimum Height

The project height has to be greater than or equal to given minimum height.

Maximum Height

The project height has to be less than or equal to given maximum height.

Fixed Width

The project width has to be equal to given fixed width.

Fixed Height

The project height has to be equal to given fixed height.

Minimum Dimensions

The project width has to be greater than or equal to given minimum width and project height has to be greater than or equal to given minimum height.

Maximum Dimensions

The project width has to be less than or equal to given maximum width and project height has to be less than or equal to given maximum height.

Fixed Dimensions

The project width and height have to be equal to the given fixed width and height, respectively.

Number of Pixels

The number of pixels is defined as width * height.

Minimum Number of Pixels

The number of pixels in the project has to be greater than or equal to given minimum number of pixels.

Maximum Number of Pixels

The number of pixels in the project has to be less than or equal to given maximum number of pixels.

Fixed Number of Pixels

The number of pixels in the project has to be equal to given fixed number of pixels.

Aspect Ratio

The aspect ratio is defined as width / height.

Minimum Aspect Ratio

The aspect ratio of the project has to be greater than or equal to given minimum aspect ratio.

Maximum Aspect Ratio

The aspect ratio of the project has to be less than or equal to given maximum aspect ratio.

Fixed Aspect Ratio

The aspect ratio of the project has to be equal to given fixed aspect ratio.

Landscape Aspect Ratio

The aspect ratio of the project has to be greater than or equal to 1. Thus, the project width has to be greater than or equal to the project height.

Portrait Aspect Ratio

The aspect ratio of the project has to be less than or equal to 1. Thus, the project width has to be less than or equal to the project height.

Examples

Bars Effect

Effect extension: Audectra/v0/Bars.cs

[MinWidth(4)]
[LandscapeAspectRatio()]
[EffectExtension("Bars", "Audectra", "1.3.0")]
class Bars : EffectExtensionBase
{
    // ...
}

Blob Effect

Effect extension: Audectra/v0/Blob.cs

[MinNumberOfPixels(8)]
[EffectExtension("Blob", "Audectra", "1.3.0")]
class Blob : EffectExtensionBase
{
    // ...
}

Fire Effect

Effect extension: Audectra/v0/Fire.cs

[MinDimensions(8, 8)]
[EffectExtension("Fire", "Audectra", "1.3.0")]
class Fire : EffectExtensionBase
{
    // ...
}