Package app.rive
See: Description
-
Object Summary Object Description Companion Companion Companion Companion Companion Fill Do not preserve aspect ratio and stretch to the containing view's dimensions. Companion Loading The operation has not completed. Companion Companion Companion Unbounded Render on every frame callback received from the platform frame clock. NoOpLogger Implementation that logs nothing. RiveLog RiveLog allows configuring logging within Rive. Companion Companion -
Class Summary Class Description Artboard An instantiated artboard from a RiveFile. Asset Base class for assets managed by a RiveWorker. ImageAsset An image asset, representing a renderable bitmap, managed by a RiveWorker. AudioAsset An audio asset, representing a playable sound, managed by a RiveWorker. FontAsset A font asset, representing a renderable typeface, managed by a RiveWorker. RiveInitializationException Exceptions related to Rive failing to initialize properly. RiveShutdownException Exceptions related to Rive failing to shut down properly. RiveRenderException Exceptions related to Rive rendering. RiveFileException Exceptions related to Rive file handling. RiveArtboardException Exceptions reported while performing an operation on a Rive artboard. RiveStateMachineException Exceptions reported while performing an operation on a Rive state machine. RiveViewModelInstanceException Exceptions reported while performing an operation on a Rive view model instance. RiveImageException Exceptions reported while decoding a Rive image asset. RiveAudioException Exceptions reported while decoding a Rive audio asset. RiveFontException Exceptions reported while decoding a Rive font asset. RiveDrawToBufferException Exceptions related to drawing to a buffer. RiveResourceClosedException Thrown when an operation requires a Rive resource that has already been closed. RiveIncompatibleResourceException Thrown when otherwise valid Rive resources cannot be used together. Layout Invokes the Rive layout engine to apply responsive layout to the artboard. Contain Preserve aspect ratio and scale the artboard so that its larger dimension matches the corresponding dimension of the containing view. ScaleDown Preserve aspect ratio and behave like Fit.Contain when the artboard is larger than the containing view. Cover Preserve aspect ratio and scale the artboard so that its smaller dimension matches the corresponding dimension of the containing view. FitWidth Preserve aspect ratio and scale the artboard width to match the containing view's width. FitHeight Preserve aspect ratio and scale the artboard height to match the containing view's height. None Do not scale. Fit Describes how size differences are handled between an authored Rive artboard and its containing view. HardwareRenderBuffer GPU-backed offscreen render target for realtime canvas presentation (API 29+). RenderBuffer Deprecated software-only legacy render buffer. Error The operation failed with throwable. Success The operation completed with value. RiveCanvasSession An entry point for Rive to render to a hardware accelerated Canvas using hardware bitmaps. RiveFile A Rive file which contains one or more artboards, state machines, and view model instances. Bytes RawRes Capped Render at no more than framesPerSecond. LogcatLogger Implementation that logs to Logcat with lazy msg()evaluation.RiveView An experimental View-based Rive renderer. SoftwareRenderBuffer CPU-backed offscreen render target for snapshot-style rendering. StateMachine An instantiated state machine from an Artboard. ViewModelInstance A view model instance for data binding which has properties that can be set and observed. Named A specific view model by name. DefaultForArtboard The default view model for the given artboard. Blank Create a new view model instance with default value initialized properties, e.g. Default Create a new view model instance with properties initialized to the values of the instance labelled "Default" in the Rive file. Named Create a new view model instance with properties initialized to the values of the instance with the given name. Reference Create a reference to an existing child view model instance. ReferenceListItem Create a reference to an existing child view model instance within a list at a given index. RememberRiveWorkerKt ArtboardKt AssetsKt ResultKt RiveKt RiveFileKt StateMachineKt ViewModelInstanceKt -
Enum Summary Enum Description Alignment Alignment of the artboard within the containing view. RenderBackend The preferred GPU rendering backend to use. RivePointerInputMode Controls how a Rive composable participates in Compose pointer input dispatch. -
Interface Summary Interface Description Result Represents an asynchronous operation that can be loading, failed, or successful. RiveFileSource The source for a RiveFile. RiveFrameRate Controls how often Rive advances and draws an active animation. Logger Interface for logging. ViewModelSource One half of a source for a ViewModelInstance. ViewModelInstanceSource The second half of a source for a ViewModelInstance. -
Annotation Summary Annotation Description ExperimentalHardwareBitmapRendering Marks APIs that use experimental hardware bitmap rendering.