aslkit library
Reads, writes, and inspects Adobe Photoshop ASL layer-style libraries.
Classes
- AslCodec
- Converts ASL models to and from their binary representation.
- AslDecodeOptions
- Resource and preservation limits applied while decoding an ASL library.
- AslDecoder
- Decodes standalone ASL libraries and Photoshop styles-palette payloads.
- AslDocumentMode
- The document color space and bit depth captured with a layer-style preset.
- AslEncodeOptions
- Preservation and validation choices applied while encoding an ASL file.
- AslEncoder
- Encodes immutable ASL models into Photoshop style-library bytes.
- AslFile
- Complete decoded contents of one Photoshop layer-style library.
- AslHierarchyEntry
-
One ordered item from a trailing Photoshop
phryhierarchy descriptor. - AslPatternRecord
- One length-prefixed pattern record embedded before ASL styles.
- AslStyle
- One length-bounded Photoshop layer-style preset.
- AslWarning
- Describes a recoverable compatibility issue found while decoding.
- PsAdjustmentSettings
- Settings of a Photoshop adjustment stored in the same layout in PSD adjustment layers and in standalone preset files.
- PsAdjustmentSettingsCodec
- Reads and writes the binary adjustment settings shared by PSD blocks and preset files.
- PsAliasValue
- Opaque length-prefixed platform alias data.
- PsBezierKnot
- One cubic Bézier knot with incoming and outgoing control handles.
- PsBezierKnotRecord
- A record containing one cubic Bézier knot.
- PsBinaryReader
- Bounds-checked big-endian input used by Photoshop format parsers.
- PsBinaryWriter
- Growable big-endian output used by the PSD writer.
- PsBlackAndWhite
- Black-and-white conversion settings, stored as an Action Descriptor.
- PsBlendOptions
-
Layer blending options stored in a
blendOptionsdescriptor. - PsBlendRange
- One Photoshop Blend If channel range.
- PsBooleanValue
- A one-byte descriptor Boolean.
- PsChannelMixer
- Channel-mixer settings.
- PsChannelMixerOutput
- One output channel of a channel-mixer adjustment.
- PsClassValue
- A Photoshop class name and identifier.
- PsColor
- An exact color descriptor with convenient named components.
- PsContour
- A Photoshop shaping curve used by contours and Satin mappings.
- PsContourPoint
- One point in a Photoshop shaping or gloss contour.
- PsDescriptor
- A Photoshop action descriptor containing ordered, typed items.
- PsDescriptorCodec
- Encodes and decodes Photoshop action descriptors.
- PsDescriptorDecodeOptions
- Resource limits applied while decoding an Action Descriptor.
- PsDescriptorEnumeration
- A Photoshop enumeration represented by its type and selected identifiers.
- PsDescriptorItem
- One keyed value inside a Photoshop action descriptor.
- PsDescriptorNumber
- A descriptor number paired with its optional Photoshop unit identifier.
- PsDescriptorValue
- Base type for Photoshop action-descriptor values.
- PsDoubleValue
- A double-precision descriptor number.
- PsEnumeratedReferenceValue
- An enumerated form inside a Photoshop object reference.
- PsEnumeratedValue
- A pair of Photoshop type and enumeration identifiers.
- PsGradient
- A Photoshop gradient descriptor preserving both stop and noise forms.
- PsGradientColorStop
- One color stop in a custom Photoshop gradient.
- PsGradientTransparencyStop
- One opacity stop in a custom Photoshop gradient.
- PsHueSaturation
- Hue/saturation settings.
- PsHueSaturationRange
- One editable color range of a hue/saturation adjustment.
- PsHueSaturationValues
- Three signed hue, saturation, and lightness values.
- PsIdentifierValue
- An integer identifier form inside a Photoshop object reference.
- PsIndexValue
- An integer index form inside a Photoshop object reference.
- PsIntegerValue
- A signed 32-bit descriptor integer.
- PsLargeIntegerValue
- A signed 64-bit descriptor integer, preserved exactly on all platforms.
- PsLayerEffect
- One layer-effect instance extracted without discarding descriptor fields.
- PsLayerEffects
-
The complete
Lefxobject and source-ordered typed effect views. - PsLevelRecord
- One channel record of a levels adjustment.
- PsLevels
- Levels settings: 29 standard channel records and optional extended ones.
- PsListValue
- An ordered list of independently typed descriptor values.
- PsNameValue
- A Unicode name form inside a Photoshop object reference.
- PsObjectArrayValue
- A descriptor-shaped object array with an explicit element count.
- PsObjectValue
- A nested action descriptor.
- PsOffsetValue
- An offset form inside a Photoshop object reference.
- PsPackBitsCodec
- Encodes and decodes the PackBits run-length format used by Photoshop.
- PsPathClipboardRecord
- A clipboard-bounds and resolution path record.
- PsPathFillRuleRecord
- A path fill-rule record, whose defined payload is normally all zeroes.
- PsPathInitialFillRecord
- The initial fill state used before applying subpath operations.
- PsPathPoint
- A two-dimensional point in Photoshop path coordinates.
- PsPathRecord
- Base type for one fixed-size Photoshop path record.
- PsPathValue
- Opaque length-prefixed Photoshop descriptor path data.
- PsPattern
- A complete Photoshop pattern record with its source planes and metadata.
- PsPatternBlockDecoder
- Decodes four-byte-aligned length-prefixed pattern records from Photoshop blocks.
- PsPatternBlockDecodeResult
- Every pattern decoded from a length-prefixed block and its retained byte cost.
- PsPatternBlockEncoder
- Encodes length-prefixed, four-byte-aligned embedded pattern records.
- PsPatternChannel
- One decoded or preserved virtual-memory channel from a Photoshop pattern.
- PsPatternChannelSlot
- One of the declared channel slots in a Photoshop virtual-memory array.
- PsPatternDecodeOptions
- Resource and preservation limits for one Photoshop pattern record.
- PsPatternDecodeResult
- One decoded pattern together with its retained uncompressed-byte cost.
- PsPatternEncodeOptions
- Preservation and validation choices applied while encoding pattern records.
- PsPatternImage
- A rendered row-major RGBA image suitable for editor integration.
- PsPatternIndexedMetadata
- The four bytes following an indexed pattern's 256-entry palette.
- PsPatternRecordDecoder
- Decodes the shared versioned pattern-record structure used by Photoshop formats.
- PsPatternRecordEncoder
- Encodes the pattern-record structure shared by PAT, ABR, ASL, and PSD data.
- PsPatternReference
- A name and stable identifier referring to an embedded Photoshop pattern.
- PsPoint
- A two-dimensional descriptor point used by layer-style offsets and phases.
- PsPresetHierarchyEntry
-
One ordered item from a Photoshop
phryhierarchy descriptor. - PsPresetHierarchyMapper
-
Converts a generic Photoshop
phrydescriptor into typed hierarchy entries. - PsPresetIdentity
- The identity fields used to resolve a hierarchy entry to a preset.
- PsPropertyValue
- A property form inside a Photoshop object reference.
- PsRawValue
- Opaque length-prefixed descriptor data.
- PsRectangle
- A rectangle using Photoshop's inclusive top/left and exclusive bottom/right convention.
- PsReferenceClassValue
- A class form inside a Photoshop object reference.
- PsReferenceValue
- An ordered Photoshop object reference.
- PsRgbColor
- An eight-bit red, green, and blue color returned by a color converter.
- PsSelectiveColor
- Selective-color settings.
- PsSelectiveColorCorrection
- A cyan, magenta, yellow, and black selective-color correction.
- PsStringValue
- A UTF-16 Photoshop descriptor string.
- PsSubpath
- One open or closed contour inside a Photoshop path.
- PsSubpathLengthRecord
- A record declaring the knot count and operation of a subpath.
- PsTaggedBlock
- One Photoshop tagged block with loss-preserving source metadata.
- PsTaggedBlockCodec
- Reads, writes, and recognizes Photoshop tagged-block framing.
- PsTaggedBlockHeader
- A decoded tagged-block header whose payload has not yet been consumed.
- PsToneCurve
- An immutable Photoshop tone curve with evaluation helpers.
- PsToneCurveCodec
- Encodes and decodes count-prefixed Photoshop tone-curve point records.
- PsToneCurvePoint
- One input-to-output control point in a Photoshop tone curve.
- PsUnitFloatsValue
- A list of double-precision values sharing a Photoshop unit code.
- PsUnitFloatValue
- A double-precision number carrying a Photoshop unit code.
- PsUnknownPathRecord
- An unrecognized 26-byte Photoshop path record.
- PsVectorPath
- An ordered Photoshop path retaining every fixed-size source record.
- PsVectorPathCodec
- Encodes and decodes streams of 26-byte Photoshop path records.
- PsVersionedDescriptor
- A Photoshop Action Descriptor preceded by its 32-bit format version.
- PsVersionedDescriptorCodec
- Encodes and decodes 32-bit-versioned Photoshop Action Descriptors.
- PsWarning
- Describes a recoverable compatibility issue found while decoding.
Enums
- AslContainerKind
-
Identifies the envelope surrounding an
8BSLstyle collection. - AslDecodeMode
- Controls whether recoverable ASL compatibility issues stop decoding.
- AslEncodeMode
- Controls how strongly an ASL document is validated before encoding.
- PsColorSpace
- Identifies the color representation used by a Photoshop color descriptor.
- PsDescriptorAccessMode
- Selects whether descriptor accessors accept compatible scalar encodings.
- PsGradientForm
- Identifies a Photoshop gradient-generation strategy.
- PsGradientStyle
- Geometry used by a gradient effect.
- PsLayerEffectKind
- Identifies a recognized Photoshop layer-effect family.
- PsPathFillRule
- Fill rule inferred from Photoshop's subpath flags.
- PsPathOperation
- Boolean operation applied when Photoshop combines a subpath.
- PsPatternColorMode
- Identifies the Photoshop color model used by a pattern record.
- PsPatternCompression
- Identifies the storage method used by a pattern channel.
- PsPatternEncodeMode
- Controls how strongly a Photoshop pattern record is validated before encoding.
- PsPatternRecordKind
- Distinguishes standalone PAT records from length-bounded embedded records.
- PsPresetHierarchyEntryKind
- Identifies the role of one Photoshop preset-hierarchy slot.
- PsStrokePosition
- Placement of a Photoshop layer stroke.
- PsToneCurveInterpolation
- Selects how values between tone-curve control points are calculated.
Extensions
- AslDescriptorAccess on PsDescriptor
- Preserves the ASL-prefixed descriptor access API while using PsCore.
- PsDescriptorAccess on PsDescriptor
- Provides null-safe typed projections over Photoshop Action Descriptors.
- PsDescriptorValueAccess on PsDescriptorValue?
- Provides typed projections for an individual nullable descriptor value.
Constants
- psMaxExactInteger → const int
- Largest integer this platform represents exactly.
- psMinExactInteger → const int
- Smallest integer this platform represents exactly.
Typedefs
- AslBlendOptions = PsBlendOptions
- Backward-compatible name for the shared blending-options view.
- AslBlendRange = PsBlendRange
- Backward-compatible name for a shared Blend If range.
- AslColor = PsColor
- Backward-compatible name for a shared color descriptor view.
- AslColorSpace = PsColorSpace
- Backward-compatible name for the shared color-space enumeration.
- AslContour = PsContour
- Backward-compatible name for a shared contour descriptor view.
- AslCurvePoint = PsContourPoint
- Backward-compatible name for a shared contour point.
- AslEffect = PsLayerEffect
- Backward-compatible name for a shared layer-effect view.
- AslEffectKind = PsLayerEffectKind
- Backward-compatible name for the shared layer-effect family enumeration.
- AslEnumeration = PsDescriptorEnumeration
- Backward-compatible name for a shared descriptor enumeration projection.
- AslGradient = PsGradient
- Backward-compatible name for a shared gradient descriptor view.
- AslGradientColorStop = PsGradientColorStop
- Backward-compatible name for a shared gradient color stop.
- AslGradientForm = PsGradientForm
- Backward-compatible name for the shared gradient-form enumeration.
- AslGradientTransparencyStop = PsGradientTransparencyStop
- Backward-compatible name for a shared gradient transparency stop.
- AslHierarchyEntryKind = PsPresetHierarchyEntryKind
- Backward-compatible name for the shared hierarchy-slot role.
- AslLayerEffects = PsLayerEffects
-
Backward-compatible name for the shared
Lefxdescriptor view. - AslNumber = PsDescriptorNumber
- Backward-compatible name for a shared descriptor number projection.
- AslPatternReference = PsPatternReference
- Backward-compatible name for a shared pattern reference.
- AslPoint = PsPoint
- Backward-compatible name for a shared two-dimensional point.
- AslTaggedBlock = PsTaggedBlock
- Backward-compatible name for a shared Photoshop tagged block.
- PsCmykToRgbConverter = PsRgbColor Function({required double black, required double cyan, required double magenta, required double yellow})
- Converts normalized CMYK ink amounts to an eight-bit RGB color.
- PsPatternDecodedBytesGuard = void Function(int bytes, int offset)
-
Verifies that retaining
bytesdecoded bytes remains within a caller's aggregate budget. - PsPatternIssueHandler = void Function(String message, int offset)
- Receives a recoverable pattern compatibility issue and its absolute byte offset.
- PsPresetHierarchyIssueHandler = void Function(String message)
- Receives a recoverable preset-hierarchy compatibility issue.
- PsTaggedBlockWideLengthResolver = bool Function(String signature, String key)
- Determines whether one Photoshop tagged block uses a 64-bit length.
Exceptions / Errors
- AslFormatException
- Reports malformed, truncated, unsupported, or unsafe ASL input.
- AslWriteException
- Reports model data that cannot be represented by the requested ASL output.
- PsFormatException
- Reports malformed, truncated, or unsupported Photoshop-format input.
- PsWriteException
- Reports data that cannot be represented by a requested Photoshop format.