Method Detail

• create

   final ImageAsset create(CommandQueue riveWorker, ByteArray bytes)

  Creates and decodes an image asset from the given byte array on the provided Rive worker.

  The image can only be used on the same RiveWorker it was created on.

  Must be registered with ImageAsset.register to be used for referenced images. Remove every registration with ImageAsset.unregister, preferably before closing the image.

  ⚠️ The lifetime of the returned image is managed by the caller. Make sure to call close when you are done with it to release its resources. The returned image holds a reference to riveWorker, so closing it is required before the worker can fully release memory associated with this image.

  This is the replacement for fromBytes. Its temporary name avoids a source-incompatible overload; it will be renamed to fromBytes in 12.0 when the result-returning API is removed.

  Parameters:

  riveWorker - The Rive worker that owns the image.

  bytes - The byte array containing the image data to decode.

• fromBytes

  @Deprecated(message = Use create. This result-returning implementation will be removed in 12.0, when create will be renamed to fromBytes and return the image directly.) final Result<ImageAsset> fromBytes(CommandQueue riveWorker, ByteArray bytes)

  Decodes an image asset from bytes.

  Parameters:

  riveWorker - The Rive worker that owns the image.

  bytes - The encoded image bytes.

• decode

   ImageHandle decode(CommandQueue worker, ByteArray bytes)

  Decode the asset from the given byte array on the provided Rive worker.

• delete

   Unit delete(CommandQueue worker, ImageHandle handle)

  Delete the asset from the provided Rive worker.

• register

   Unit register(CommandQueue worker, String key, ImageHandle handle)

  Register the asset with the provided Rive worker under the given key.

• unregister

   Unit unregister(CommandQueue worker, String key)

  Unregister the asset from the provided Rive worker for the given key.

• construct

   ImageAsset construct(ImageHandle handle, CommandQueue worker)

  Construct the asset by taking ownership of the worker reference acquired by the factory.

• getTag

   String getTag()

  The tag used for logging purposes.

• getLabel

   String getLabel()

  A label for the asset type, used in logging.