DevelopPresetMask

Endpoints · All schemas

Field	Required	Description
adjustments	No	See definition below
amount	No	How much of the adjustment is applied, as a percentage
enabled	No	A disabled mask is kept but not rendered
endX	No	Where a linear mask has faded out, across the frame
endY	No	Where a linear mask has faded out, down the frame
feather	No	Softness of a radial edge as a percentage of the radius, or of a brush stroke as one of its radius
id	Yes	Client-chosen identifier, unique within the recipe
invert	No	Apply the adjustment outside the shape instead of inside
kind	Yes	See definition below
name	No	Optional name shown in the editor
radiusX	No	Horizontal radius of a radial mask as a fraction of the frame width
radiusY	No	Vertical radius of a radial mask as a fraction of the frame height
x	Yes	Centre (radial) or start (linear) across the oriented frame; any value for brush and bitmap masks
y	Yes	Centre (radial) or start (linear) down the oriented frame; any value for brush and bitmap masks

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: AssetDevelopMaskAdjustments, DevelopPresetMaskKind

{
  "properties": {
    "adjustments": {
      "$ref": "#/components/schemas/AssetDevelopMaskAdjustments",
      "default": {
        "blacks": 0,
        "contrast": 0,
        "dehaze": 0,
        "exposure": 0,
        "highlights": 0,
        "saturation": 0,
        "shadows": 0,
        "temperature": 0,
        "tint": 0,
        "vibrance": 0,
        "whites": 0
      }
    },
    "amount": {
      "default": 100,
      "description": "How much of the adjustment is applied, as a percentage",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "enabled": {
      "default": true,
      "description": "A disabled mask is kept but not rendered",
      "type": "boolean"
    },
    "endX": {
      "default": 0.5,
      "description": "Where a linear mask has faded out, across the frame",
      "format": "double",
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "endY": {
      "default": 1,
      "description": "Where a linear mask has faded out, down the frame",
      "format": "double",
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "feather": {
      "default": 50,
      "description": "Softness of a radial edge as a percentage of the radius, or of a brush stroke as one of its radius",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "id": {
      "description": "Client-chosen identifier, unique within the recipe",
      "maxLength": 40,
      "minLength": 1,
      "type": "string"
    },
    "invert": {
      "default": false,
      "description": "Apply the adjustment outside the shape instead of inside",
      "type": "boolean"
    },
    "kind": {
      "$ref": "#/components/schemas/DevelopPresetMaskKind"
    },
    "name": {
      "default": null,
      "description": "Optional name shown in the editor",
      "maxLength": 60,
      "minLength": 1,
      "nullable": true,
      "type": "string"
    },
    "radiusX": {
      "default": 0.25,
      "description": "Horizontal radius of a radial mask as a fraction of the frame width",
      "format": "double",
      "maximum": 1,
      "minimum": 0.01,
      "type": "number"
    },
    "radiusY": {
      "default": 0.25,
      "description": "Vertical radius of a radial mask as a fraction of the frame height",
      "format": "double",
      "maximum": 1,
      "minimum": 0.01,
      "type": "number"
    },
    "x": {
      "description": "Centre (radial) or start (linear) across the oriented frame; any value for brush and bitmap masks",
      "format": "double",
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "y": {
      "description": "Centre (radial) or start (linear) down the oriented frame; any value for brush and bitmap masks",
      "format": "double",
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    }
  },
  "required": [
    "id",
    "kind",
    "x",
    "y"
  ],
  "type": "object"
}