JxlEncoderSetFrameName

Function JxlEncoderSetFrameName 

Source
pub unsafe extern "C-unwind" fn JxlEncoderSetFrameName(
    frame_settings: *mut JxlEncoderFrameSettings,
    frame_name: *const u8,
) -> JxlEncoderStatus
Expand description

Sets the name of the animation frame. This function is optional, frames are not required to have a name. This setting is a part of the frame header, and the same principles as for JxlEncoderSetFrameHeader apply. The name_length field of JxlFrameHeader is ignored by the encoder, this function determines the name length instead as the length in bytes of the C string.

The maximum possible name length is 1071 bytes (excluding terminating null character).

Calling JxlEncoderSetFrameHeader clears any name that was previously set.

§Parameters

  • frame_settings: set of options and metadata for this frame. Also includes reference to the encoder object.
  • frame_name: name of the next frame to be encoded, as a UTF-8 encoded C string (zero terminated). Owned by the caller, and copied internally.

§Returns