Module plugin_sdk 

Re-exports for plugin authors.

Modules

abi

Re-exported ABI types shared with PixelFlow host.

builders

Safe builders for Rust plugin authors.

registration

Safe wrappers around host registration callbacks.

Macros

pixelflow_plugin

Exports pixelflow_plugin_entry_v2 for Rust plugin type.

Structs

Clip

Immutable script-facing clip handle.

ClipMedia

Declared media properties for one clip.

ClipMetadata

Schema-validated clip-level metadata constants.

ErrorCode

Stable machine-readable error code within an ErrorCategory.

ExecutorRequest

Safe executor factory request passed once per graph node.

ExpansionRequest

Safe expansion request passed to Rust plugin expander callbacks.

FilterExecutorRequest

Borrowed inputs for creating one runtime executor for a graph filter node.

FilterExpansionRequest

Borrowed inputs for expanding one public filter into private helper nodes.

FilterPlan

Planned graph-node metadata for one filter call.

FilterPlanRequest

Borrowed inputs for planning one filter node.

FilterRegistration

Safe filter declaration used by Rust plugins.

Frame

Immutable ref-counted frame handle.

FrameBuilder

Builder used for explicit output allocation and writes.

FrameRequest

Request object passed to Rust plugin frame executors.

Logger

Cloneable logger handle used by core and downstream crates.

Metadata

Typed metadata map validated against a MetadataSchema.

MetadataRegistration

Safe metadata key declaration used by Rust plugins.

MetadataSchema

Metadata schema for core keys and plugin extension keys.

PixelFlowError

Structured error value used by public PixelFlow APIs.

PixelflowFilterDescriptorV2

C-compatible filter descriptor.

PixelflowFrameExecutorV2

Plugin-owned executor callback table.

PixelflowHostApiV2

Host callback table passed to plugins.

PixelflowPluginApiV2

Plugin callback table filled by entry symbol.

PixelflowRegistrar

Opaque host registrar handle.

PixelflowStatus

Structured ABI status returned by plugin and host callbacks.

PixelflowStringView

Borrowed UTF-8 string passed across ABI calls.

PlanRequest

Safe planner request passed to Rust plugin planner callbacks.

Plane

Typed immutable plane view.

PlaneMut

Typed mutable plane view available while building outputs.

Rational

Rational metadata value.

RawPlane

Raw immutable plane view used by expert Rust and C ABI adapters.

RawPlaneMut

Raw mutable plane view used by expert builders and C ABI adapters.

RegistrationContext

Safe host registration context passed to Rust plugins.

Enums

ClipFormat

Format state known for graph clip.

ClipResolution

Resolution state known for graph clip.

ConcurrencyClass

Declares how scheduler may run node callbacks across frames.

DependencyPattern

Declares which upstream frames a node may request while producing one output frame.

DynamicDependencyBounds

Runtime bounds for frame-map and dynamic dependencies.

ErrorCategory

Stable high-level category for routing errors across APIs and plugins.

FilterCompatibility

Filter media compatibility policy used during validation.

FilterOptionValue

Generic script-provided option value for filter planning.

FilterVisibility

Script visibility for a registered filter descriptor.

FrameCount

Frame-count state known for graph clip.

FrameRate

Frame-rate state known for graph clip.

LogLevel

Severity for records emitted through PixelFlow logging hooks.

MetadataKind

Declared metadata type for schema entries.

MetadataValue

Typed metadata value.

PixelflowErrorCategory

ABI error category.

PixelflowMetadataKind

ABI metadata value kind.

SampleType

Stored scalar type for plane samples.

Constants

FRAME_ALIGNMENT

Fixed byte alignment for frame plane storage and row strides.

PIXELFLOW_ABI_VERSION

Current plugin ABI version.

PIXELFLOW_FILTER_DESCRIPTOR_FLAG_EXPANDER

Filter descriptor flag: reserve this filter for graph expansion entry points.

PIXELFLOW_FILTER_DESCRIPTOR_FLAG_PRIVATE

Filter descriptor flag: hide this filter from public script lookup.

PIXELFLOW_FILTER_DESCRIPTOR_KNOWN_FLAGS

Filter descriptor flags understood by this ABI version.

PIXELFLOW_PLUGIN_ENTRY_SYMBOL

Versioned entry symbol exported by PixelFlow plugins.

PLUGIN_ABI_VERSION

Version of the planned C-compatible plugin ABI entry point.

Traits

FrameExecutor

Safe frame executor trait for Rust plugin authors.

Plugin

Minimal plugin contract used by future SDK builders and shims.

RegistrationSink

Capability required by registration contexts.

Sample

Sample marker trait for supported plane sample types.

Type Aliases

ExecutorFactoryCallback

Executor factory callback type used by Rust plugin authors.

ExpanderCallback

Expander callback type used by Rust plugin authors.

FilterOptions

Deterministically sorted filter option map.

PixelflowDestroyUserDataV2

Destroys plugin-owned callback user data.

PixelflowExecutorCommitV2

Commits one prepared frame through a plugin-owned executor.

PixelflowExecutorDestroyV2

Destroys plugin-owned executor state.

PixelflowExecutorFactoryV2

Rust-SDK executor factory callback. Opaque pointers reference host-owned Rust request/result slots.

PixelflowExecutorPrepareV2

Prepares one frame through a plugin-owned executor.

PixelflowFilterExpanderV2

Rust-SDK expander callback. Opaque pointers reference host-owned Rust request/result slots.

PixelflowFilterPlannerV2

Rust-SDK planner callback. Opaque pointers reference host-owned Rust request/result slots.

PixelflowPluginEntryV2

Type of pixelflow_plugin_entry_v2.

PlannerCallback

Planner callback type used by Rust plugin authors.

Result

Convenient result alias for PixelFlow operations.