pixa library

Classes

Pixa: Global Pixa entrypoint.
PixaAnimationController: Controls frame scheduling for one or more controlled animated image streams.
PixaAnimationOptions: Playback options for a controlled animated image stream.
PixaAssetSource: Flutter asset image source.
PixaBytesSource: Raw encoded bytes image source.
PixaCachePolicy: Cache policy attached to a request.
PixaCacheStats: Snapshot of Pixa cache behavior.
PixaCacheWarmupEntry: One request in a cache warmup manifest.
PixaCacheWarmupFailure: One failed warmup entry.
PixaCacheWarmupManifest: Batch prefetch manifest for app startup and offline warmup.
PixaCacheWarmupReport: Summary produced after running a warmup manifest.
PixaCallbackObserver: Observer that forwards events to a callback.
PixaCancelled: Cancelled state.
PixaCompleted: Completed state.
PixaConfig: Global Pixa configuration.
PixaController: Lifecycle controller for Pixa widgets.
PixaCustomSource: Custom image source.
PixaDecodedCacheStats: Snapshot of Flutter decoded image cache behavior.
PixaEvent: Structured event emitted by Pixa.
PixaExifThumbnailSource: Embedded JPEG EXIF thumbnail source for a local image.
PixaFailed: Failed state.
PixaFileSource: Filesystem image source.
PixaHeadersPolicy: Header policy for cache-key participation.
PixaIdle: Idle state.
PixaImage: Flutter image widget backed by the Rust Pixa pipeline.
PixaImageAnalysis: Low-cost color analysis for encoded image bytes.
PixaImageMetadata: Image metadata parsed from encoded headers without full pixel decode.
PixaLargeImage: Selects, positions, and renders visible tiles for very large images.
PixaLargeImageController: Controller for a PixaLargeImage.
PixaLargeImageSize: Immutable source image dimensions for tile planning.
PixaLargeImageTile: One visible or prefetched tile.
PixaLargeImageTilePlan: A tile plan for the current viewport and zoom.
PixaLargeImageTilePlanner: Computes tile coverage independently from widget rendering.
PixaLoading: Loading state.
PixaLoadState: Load state emitted by controllers and widgets.
PixaLogObserver: Observer that formats redacted single-line logs for local debugging.
PixaMemorySource: Memory object image source.
PixaNetworkSource: HTTP or HTTPS image source.
PixaObserver: Observer interface for request, cache, scheduler, runtime, and failure events.
PixaObserverSamplingPolicy: Observer sampling policy for high-frequency event streams.
PixaPipeline: runtime-backed Pixa image pipeline.
PixaPipelineHandle: Cancellable listener handle for a scheduled pipeline load.
PixaPipelineLoad: Encoded load result.
PixaPlaceholder: Placeholder descriptor.
PixaPlugin: Pixa plugin contract.
PixaPluginExecutionPolicy: Per-request plugin execution boundary.
PixaPredictivePrefetcher: Component-agnostic predictive prefetcher for scrollable galleries.
PixaPredictivePrefetcherSnapshot: Queue snapshot for predictive prefetch debug surfaces and benchmarks.
PixaProcessors: Helpers for building stable runtime processor descriptors.
PixaProgress: Immutable progress event emitted by the Pixa pipeline.
PixaProgressivePreview: Encoded progressive preview bytes emitted during network loading.
PixaProvider: Flutter ImageProvider backed by the Rust Pixa pipeline.
PixaRedirectPolicy: Redirect safety policy for network image requests.
PixaRequest: Immutable request consumed by the image pipeline.
PixaRequestLimits: Limits protecting memory, network, and decoder resources.
PixaRequestSnapshot: Redacted request payload safe for observers, logs, and debug panels.
PixaResponsiveImage: Layout-aware image widget backed by a PixaSourceSet.
PixaRetryPolicy: Retry policy used by fetch and decode stages.
PixaRuntimePluginSource: Runtime plugin source.
PixaSource: Image source handled by the Pixa pipeline.
PixaSourceSet: Responsive image source set selection model.
PixaSourceSetCandidate: One candidate in a responsive Pixa source set.
PixaTargetSize: Target encoded or decoded size.
PixaVersionConstraint: Small semver-compatible constraint used to avoid depending on pub_semver.
PixaVideoFrameOptions: Options that identify a video frame variant before image processing.
PixaVideoFrameSource: Runtime-backed video frame image source.

Enums

PixaAnimationDisposalPolicy: Disposal policy applied when controlled animation playback stops.
PixaAnimationFrameCachePolicy: Decoded-frame retention policy for controlled animation playback.
PixaAnimationPlaybackState: Playback state for a Pixa animated image stream.
PixaCacheMode: Cache behavior for a request.
PixaImageMetadataFormat: Encoded image format identified from runtime metadata probing.
PixaLargeImageTileMode: Tile selection strategy for PixaLargeImage.
PixaMemoryTrimLevel: Memory trim severity for coordinated Pixa and Flutter cache pressure.
PixaPrefetchTarget: Prefetch destination.
PixaPriority: Image priority used by the scheduler.
PixaResizeFilter: Resize sampling filter for runtime processors.
PixaResizeMode: Resize behavior for PixaProcessors.resize.
PixaRetryability: Retry classification for failures.
PixaRetryMode: Retry strategy.
PixaStage: Pipeline stage for progress, failures, and observer events.
PixaVideoFrameSelection: How a requested video frame timestamp should be selected.

Typedefs

PixaCacheWarmupExecutor = FutureOr<void> Function(PixaCacheWarmupEntry entry): Executes one cache warmup entry.
PixaCustomSourceLoader = Future<Uint8List> Function(): Function used by custom sources to provide encoded bytes.
PixaErrorBuilder = Widget Function(BuildContext context, PixaFailure failure, VoidCallback retry): Builds an error UI with a retry callback.
PixaIndexedRequestBuilder = PixaRequest? Function(int index): Builds a request for an item index.
PixaPrefetchRunner = Future<void> Function(PixaRequest request, {required PixaPrefetchTarget target}): Runs one prefetch operation.
PixaProgressBuilder = Widget Function(BuildContext context, PixaProgress? progress): Builds a loading UI with the latest progress event.

Exceptions / Errors

PixaFailure: Typed pipeline failure.

Classes

Enums

Typedefs

Exceptions / Errors

pixa package

pixa library