Struct photon_rs::PhotonImage

pub struct PhotonImage { /* private fields */ }

Provides the image’s height, width, and contains the image’s raw pixels. For use when communicating between JS and WASM, and also natively.

Implementations

impl PhotonImage

pub fn new(raw_pixels: Vec<u8>, width: u32, height: u32) -> PhotonImage

Create a new PhotonImage from a Vec of u8s, which represent raw pixels.

pub fn new_from_base64(base64: &str) -> PhotonImage

Create a new PhotonImage from a base64 string.

pub fn new_from_byteslice(vec: Vec<u8>) -> PhotonImage

Create a new PhotonImage from a byteslice.

pub fn get_width(&self) -> u32

Get the width of the PhotonImage.

pub fn get_raw_pixels(&self) -> Vec<u8>

Get the PhotonImage’s pixels as a Vec of u8s.

pub fn get_height(&self) -> u32

Get the height of the PhotonImage.

pub fn get_base64(&self) -> String

Convert the PhotonImage to base64.

pub fn get_bytes(&self) -> Vec<u8>

Convert the PhotonImage to raw bytes. Returns JPEG.

pub fn get_bytes_jpeg(&self, quality: u8) -> Vec<u8>

Convert the PhotonImage to raw bytes. Returns a JPEG.

pub fn get_image_data(&mut self) -> ImageData

Convert the PhotonImage’s raw pixels to JS-compatible ImageData.

pub fn set_imgdata(&mut self, img_data: ImageData)

Convert ImageData to raw pixels, and update the PhotonImage’s raw pixels to this.

Trait Implementations

impl Clone for PhotonImage

fn clone(&self) -> PhotonImage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PhotonImage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PhotonImage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ImageData> for PhotonImage

Create a new PhotonImage from a raw Vec of u8s representing raw image pixels.

fn from(imgdata: ImageData) -> Self

Converts to this type from the input type.

impl From<PhotonImage> for JsValue

fn from(value: PhotonImage) -> Self

Converts to this type from the input type.

impl FromWasmAbi for PhotonImage

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for PhotonImage

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for PhotonImage

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for PhotonImage

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for PhotonImage

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, PhotonImage>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for PhotonImage

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, PhotonImage>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl Serialize for PhotonImage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl WasmDescribe for PhotonImage

fn describe()