3227 lines
101 KiB
TypeScript
3227 lines
101 KiB
TypeScript
/* tslint:disable */
|
|
/* eslint-disable */
|
|
/**
|
|
* Alter a select channel by incrementing or decrementing its value by a constant.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `channel` - The channel you wish to alter, it should be either 0, 1 or 2,
|
|
* representing R, G, or B respectively. (O=Red, 1=Green, 2=Blue)
|
|
* * `amount` - The amount to increment/decrement the channel's value by for that pixel.
|
|
* A positive value will increment/decrement the channel's value, a negative value will decrement the channel's value.
|
|
*
|
|
* ## Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to increase the Red channel for all pixels by 10:
|
|
* use photon_rs::channels::alter_channel;
|
|
* use photon_rs::native::{open_image};
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* alter_channel(&mut img, 0_usize, 10_i16);
|
|
* ```
|
|
*
|
|
* Adds a constant to a select R, G, or B channel's value.
|
|
*
|
|
* ### Decrease a channel's value
|
|
* // For example, to decrease the Green channel for all pixels by 20:
|
|
* ```no_run
|
|
* use photon_rs::channels::alter_channel;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* alter_channel(&mut img, 1_usize, -20_i16);
|
|
* ```
|
|
* **Note**: Note the use of a minus symbol when decreasing the channel.
|
|
* @param {PhotonImage} img
|
|
* @param {number} channel
|
|
* @param {number} amt
|
|
*/
|
|
export function alter_channel(img: PhotonImage, channel: number, amt: number): void;
|
|
/**
|
|
* Increment or decrement every pixel's Red channel by a constant.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage. See the PhotonImage struct for details.
|
|
* * `amt` - The amount to increment or decrement the channel's value by for that pixel.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to increase the Red channel for all pixels by 10:
|
|
* use photon_rs::channels::alter_red_channel;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* alter_red_channel(&mut img, 10_i16);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} amt
|
|
*/
|
|
export function alter_red_channel(photon_image: PhotonImage, amt: number): void;
|
|
/**
|
|
* Increment or decrement every pixel's Green channel by a constant.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `amt` - The amount to increment/decrement the channel's value by for that pixel.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to increase the Green channel for all pixels by 20:
|
|
* use photon_rs::channels::alter_green_channel;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* alter_green_channel(&mut img, 20_i16);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} amt
|
|
*/
|
|
export function alter_green_channel(img: PhotonImage, amt: number): void;
|
|
/**
|
|
* Increment or decrement every pixel's Blue channel by a constant.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `amt` - The amount to increment or decrement the channel's value by for that pixel.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to increase the Blue channel for all pixels by 10:
|
|
* use photon_rs::channels::alter_blue_channel;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* alter_blue_channel(&mut img, 10_i16);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} amt
|
|
*/
|
|
export function alter_blue_channel(img: PhotonImage, amt: number): void;
|
|
/**
|
|
* Increment/decrement two channels' values simultaneously by adding an amt to each channel per pixel.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `channel1` - A usize from 0 to 2 that represents either the R, G or B channels.
|
|
* * `amt1` - The amount to increment/decrement the channel's value by for that pixel.
|
|
* * `channel2` -A usize from 0 to 2 that represents either the R, G or B channels.
|
|
* * `amt2` - The amount to increment/decrement the channel's value by for that pixel.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to increase the values of the Red and Blue channels per pixel:
|
|
* use photon_rs::channels::alter_two_channels;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* alter_two_channels(&mut img, 0_usize, 10_i16, 2_usize, 20_i16);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} channel1
|
|
* @param {number} amt1
|
|
* @param {number} channel2
|
|
* @param {number} amt2
|
|
*/
|
|
export function alter_two_channels(img: PhotonImage, channel1: number, amt1: number, channel2: number, amt2: number): void;
|
|
/**
|
|
* Increment all 3 channels' values by adding an amt to each channel per pixel.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `r_amt` - The amount to increment/decrement the Red channel by.
|
|
* * `g_amt` - The amount to increment/decrement the Green channel by.
|
|
* * `b_amt` - The amount to increment/decrement the Blue channel by.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to increase the values of the Red channel by 10, the Green channel by 20,
|
|
* // and the Blue channel by 50:
|
|
* use photon_rs::channels::alter_channels;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* alter_channels(&mut img, 10_i16, 20_i16, 50_i16);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} r_amt
|
|
* @param {number} g_amt
|
|
* @param {number} b_amt
|
|
*/
|
|
export function alter_channels(img: PhotonImage, r_amt: number, g_amt: number, b_amt: number): void;
|
|
/**
|
|
* Set a certain channel to zero, thus removing the channel's influence in the pixels' final rendered colour.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `channel` - The channel to be removed; must be a usize from 0 to 2, with 0 representing Red, 1 representing Green, and 2 representing Blue.
|
|
* * `min_filter` - Minimum filter. Value between 0 and 255. Only remove the channel if the current pixel's channel value is less than this minimum filter. To completely
|
|
* remove the channel, set this value to 255, to leave the channel as is, set to 0, and to set a channel to zero for a pixel whose red value is greater than 50,
|
|
* then channel would be 0 and min_filter would be 50.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to remove the Red channel with a min_filter of 100:
|
|
* use photon_rs::channels::remove_channel;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* remove_channel(&mut img, 0_usize, 100_u8);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} channel
|
|
* @param {number} min_filter
|
|
*/
|
|
export function remove_channel(img: PhotonImage, channel: number, min_filter: number): void;
|
|
/**
|
|
* Remove the Red channel's influence in an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `min_filter` - Only remove the channel if the current pixel's channel value is less than this minimum filter.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to remove the red channel for red channel pixel values less than 50:
|
|
* use photon_rs::channels::remove_red_channel;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* remove_red_channel(&mut img, 50_u8);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} min_filter
|
|
*/
|
|
export function remove_red_channel(img: PhotonImage, min_filter: number): void;
|
|
/**
|
|
* Remove the Green channel's influence in an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `min_filter` - Only remove the channel if the current pixel's channel value is less than this minimum filter.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to remove the green channel for green channel pixel values less than 50:
|
|
* use photon_rs::channels::remove_green_channel;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* remove_green_channel(&mut img, 50_u8);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} min_filter
|
|
*/
|
|
export function remove_green_channel(img: PhotonImage, min_filter: number): void;
|
|
/**
|
|
* Remove the Blue channel's influence in an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `min_filter` - Only remove the channel if the current pixel's channel value is less than this minimum filter.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to remove the blue channel for blue channel pixel values less than 50:
|
|
* use photon_rs::channels::remove_blue_channel;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* remove_blue_channel(&mut img, 50_u8);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} min_filter
|
|
*/
|
|
export function remove_blue_channel(img: PhotonImage, min_filter: number): void;
|
|
/**
|
|
* Swap two channels.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `channel1` - An index from 0 to 2, representing the Red, Green or Blue channels respectively. Red would be represented by 0, Green by 1, and Blue by 2.
|
|
* * `channel2` - An index from 0 to 2, representing the Red, Green or Blue channels respectively. Same as above.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to swap the values of the Red channel with the values of the Blue channel:
|
|
* use photon_rs::channels::swap_channels;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* swap_channels(&mut img, 0_usize, 2_usize);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} channel1
|
|
* @param {number} channel2
|
|
*/
|
|
export function swap_channels(img: PhotonImage, channel1: number, channel2: number): void;
|
|
/**
|
|
* Invert RGB value of an image.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A DynamicImage that contains a view into the image.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::channels::invert;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* invert(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function invert(photon_image: PhotonImage): void;
|
|
/**
|
|
* Selective hue rotation.
|
|
*
|
|
* Only rotate the hue of a pixel if its RGB values are within a specified range.
|
|
* This function only rotates a pixel's hue to another if it is visually similar to the colour specified.
|
|
* For example, if a user wishes all pixels that are blue to be changed to red, they can selectively specify only the blue pixels to be changed.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `ref_color` - The `RGB` value of the reference color (to be compared to)
|
|
* * `degrees` - The amount of degrees to hue rotate by.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to only rotate the pixels that are of RGB value RGB{20, 40, 60}:
|
|
* use photon_rs::Rgb;
|
|
* use photon_rs::channels::selective_hue_rotate;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let ref_color = Rgb::new(20_u8, 40_u8, 60_u8);
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* selective_hue_rotate(&mut img, ref_color, 180_f32);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {Rgb} ref_color
|
|
* @param {number} degrees
|
|
*/
|
|
export function selective_hue_rotate(photon_image: PhotonImage, ref_color: Rgb, degrees: number): void;
|
|
/**
|
|
* Selectively change pixel colours which are similar to the reference colour provided.
|
|
*
|
|
* Similarity between two colours is calculated via the CIE76 formula.
|
|
* Only changes the color of a pixel if its similarity to the reference colour is within the range in the algorithm.
|
|
* For example, with this function, a user can change the color of all blue pixels by mixing them with red by 10%.
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* * `ref_color` - The `RGB` value of the reference color (to be compared to)
|
|
* * `new_color` - The `RGB` value of the new color (to be mixed with the matched pixels)
|
|
* * `fraction` - The amount of mixing the new colour with the matched pixels
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to only change the color of pixels that are similar to the RGB value RGB{200, 120, 30} by mixing RGB{30, 120, 200} with 25%:
|
|
* use photon_rs::Rgb;
|
|
* use photon_rs::channels::selective_color_convert;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let ref_color = Rgb::new(200, 120, 30);
|
|
* let new_color = Rgb::new(30, 120, 200);
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* selective_color_convert(&mut img, ref_color, new_color, 0.25);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {Rgb} ref_color
|
|
* @param {Rgb} new_color
|
|
* @param {number} fraction
|
|
*/
|
|
export function selective_color_convert(photon_image: PhotonImage, ref_color: Rgb, new_color: Rgb, fraction: number): void;
|
|
/**
|
|
* Selectively lighten an image.
|
|
*
|
|
* Only lighten the hue of a pixel if its colour matches or is similar to the RGB colour specified.
|
|
* For example, if a user wishes all pixels that are blue to be lightened, they can selectively specify only the blue pixels to be changed.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `ref_color` - The `RGB` value of the reference color (to be compared to)
|
|
* * `amt` - The level from 0 to 1 to lighten the hue by. Increasing by 10% would have an `amt` of 0.1
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to only lighten the pixels that are of or similar to RGB value RGB{20, 40, 60}:
|
|
* use photon_rs::Rgb;
|
|
* use photon_rs::channels::selective_lighten;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let ref_color = Rgb::new(20_u8, 40_u8, 60_u8);
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* selective_lighten(&mut img, ref_color, 0.2_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {Rgb} ref_color
|
|
* @param {number} amt
|
|
*/
|
|
export function selective_lighten(img: PhotonImage, ref_color: Rgb, amt: number): void;
|
|
/**
|
|
* Selectively desaturate pixel colours which are similar to the reference colour provided.
|
|
*
|
|
* Similarity between two colours is calculated via the CIE76 formula.
|
|
* Only desaturates the hue of a pixel if its similarity to the reference colour is within the range in the algorithm.
|
|
* For example, if a user wishes all pixels that are blue to be desaturated by 0.1, they can selectively specify only the blue pixels to be changed.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `ref_color` - The `RGB` value of the reference color (to be compared to)
|
|
* * `amt` - The amount of desaturate the colour by.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to only desaturate the pixels that are similar to the RGB value RGB{20, 40, 60}:
|
|
* use photon_rs::Rgb;
|
|
* use photon_rs::channels::selective_desaturate;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let ref_color = Rgb::new(20_u8, 40_u8, 60_u8);
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* selective_desaturate(&mut img, ref_color, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {Rgb} ref_color
|
|
* @param {number} amt
|
|
*/
|
|
export function selective_desaturate(img: PhotonImage, ref_color: Rgb, amt: number): void;
|
|
/**
|
|
* Selectively saturate pixel colours which are similar to the reference colour provided.
|
|
*
|
|
* Similarity between two colours is calculated via the CIE76 formula.
|
|
* Only saturates the hue of a pixel if its similarity to the reference colour is within the range in the algorithm.
|
|
* For example, if a user wishes all pixels that are blue to have an increase in saturation by 10%, they can selectively specify only the blue pixels to be changed.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `ref_color` - The `RGB` value of the reference color (to be compared to)
|
|
* * `amt` - The amount of saturate the colour by.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to only increase the saturation of pixels that are similar to the RGB value RGB{20, 40, 60}:
|
|
* use photon_rs::Rgb;
|
|
* use photon_rs::channels::selective_saturate;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let ref_color = Rgb::new(20_u8, 40_u8, 60_u8);
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* selective_saturate(&mut img, ref_color, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {Rgb} ref_color
|
|
* @param {number} amt
|
|
*/
|
|
export function selective_saturate(img: PhotonImage, ref_color: Rgb, amt: number): void;
|
|
/**
|
|
* Selectively changes a pixel to greyscale if it is *not* visually similar or close to the colour specified.
|
|
* Only changes the colour of a pixel if its RGB values are within a specified range.
|
|
*
|
|
* (Similarity between two colours is calculated via the CIE76 formula.)
|
|
* For example, if a user wishes all pixels that are *NOT* blue to be displayed in greyscale, they can selectively specify only the blue pixels to be
|
|
* kept in the photo.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `ref_color` - The `RGB` value of the reference color (to be compared to)
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to greyscale all pixels that are *not* visually similar to the RGB colour RGB{20, 40, 60}:
|
|
* use photon_rs::Rgb;
|
|
* use photon_rs::channels::selective_greyscale;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let ref_color = Rgb::new(20_u8, 40_u8, 60_u8);
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* selective_greyscale(img, ref_color);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {Rgb} ref_color
|
|
*/
|
|
export function selective_greyscale(photon_image: PhotonImage, ref_color: Rgb): void;
|
|
/**
|
|
* Apply a monochrome effect of a certain colour.
|
|
*
|
|
* It does so by averaging the R, G, and B values of a pixel, and then adding a
|
|
* separate value to that averaged value for each channel to produce a tint.
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* * `r_offset` - The value to add to the Red channel per pixel.
|
|
* * `g_offset` - The value to add to the Green channel per pixel.
|
|
* * `b_offset` - The value to add to the Blue channel per pixel.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply a monochrome effect to an image:
|
|
* use photon_rs::monochrome::monochrome;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* monochrome(&mut img, 40_u32, 50_u32, 100_u32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} r_offset
|
|
* @param {number} g_offset
|
|
* @param {number} b_offset
|
|
*/
|
|
export function monochrome(img: PhotonImage, r_offset: number, g_offset: number, b_offset: number): void;
|
|
/**
|
|
* Convert an image to sepia.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to sepia an image of type `PhotonImage`:
|
|
* use photon_rs::monochrome::sepia;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* sepia(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function sepia(img: PhotonImage): void;
|
|
/**
|
|
* Convert an image to grayscale using the conventional averaging algorithm.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to convert an image of type `PhotonImage` to grayscale:
|
|
* use photon_rs::monochrome::grayscale;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* grayscale(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function grayscale(img: PhotonImage): void;
|
|
/**
|
|
* Convert an image to grayscale with a human corrected factor, to account for human vision.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to convert an image of type `PhotonImage` to grayscale with a human corrected factor:
|
|
* use photon_rs::monochrome::grayscale_human_corrected;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* grayscale_human_corrected(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function grayscale_human_corrected(img: PhotonImage): void;
|
|
/**
|
|
* Desaturate an image by getting the min/max of each pixel's RGB values.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to desaturate an image:
|
|
* use photon_rs::monochrome::desaturate;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* desaturate(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function desaturate(img: PhotonImage): void;
|
|
/**
|
|
* Uses a min. decomposition algorithm to convert an image to greyscale.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to decompose an image with min decomposition:
|
|
* use photon_rs::monochrome::decompose_min;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* decompose_min(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function decompose_min(img: PhotonImage): void;
|
|
/**
|
|
* Uses a max. decomposition algorithm to convert an image to greyscale.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to decompose an image with max decomposition:
|
|
* use photon_rs::monochrome::decompose_max;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* decompose_max(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function decompose_max(img: PhotonImage): void;
|
|
/**
|
|
* Employ only a limited number of gray shades in an image.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* * `num_shades` - The number of grayscale shades to be displayed in the image.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to limit an image to four shades of gray only:
|
|
* use photon_rs::monochrome::grayscale_shades;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* grayscale_shades(&mut img, 4_u8);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} num_shades
|
|
*/
|
|
export function grayscale_shades(photon_image: PhotonImage, num_shades: number): void;
|
|
/**
|
|
* Convert an image to grayscale by setting a pixel's 3 RGB values to the Red channel's value.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::monochrome::r_grayscale;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* r_grayscale(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function r_grayscale(photon_image: PhotonImage): void;
|
|
/**
|
|
* Convert an image to grayscale by setting a pixel's 3 RGB values to the Green channel's value.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::monochrome::g_grayscale;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* g_grayscale(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function g_grayscale(photon_image: PhotonImage): void;
|
|
/**
|
|
* Convert an image to grayscale by setting a pixel's 3 RGB values to the Blue channel's value.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::monochrome::b_grayscale;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* b_grayscale(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function b_grayscale(photon_image: PhotonImage): void;
|
|
/**
|
|
* Convert an image to grayscale by setting a pixel's 3 RGB values to a chosen channel's value.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* * `channel` - A usize representing the channel from 0 to 2. O represents the Red channel, 1 the Green channel, and 2 the Blue channel.
|
|
*
|
|
* # Example
|
|
* To grayscale using only values from the Red channel:
|
|
* ```no_run
|
|
* use photon_rs::monochrome::single_channel_grayscale;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* single_channel_grayscale(&mut img, 0_usize);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} channel
|
|
*/
|
|
export function single_channel_grayscale(photon_image: PhotonImage, channel: number): void;
|
|
/**
|
|
* Threshold an image using a standard thresholding algorithm.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* * `threshold` - The amount the image should be thresholded by from 0 to 255.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to threshold an image of type `PhotonImage`:
|
|
* use photon_rs::monochrome::threshold;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* threshold(&mut img, 30_u32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} threshold
|
|
*/
|
|
export function threshold(img: PhotonImage, threshold: number): void;
|
|
/**
|
|
* Applies gamma correction to an image.
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage that contains a view into the image.
|
|
* * `red` - Gamma value for red channel.
|
|
* * `green` - Gamma value for green channel.
|
|
* * `blue` - Gamma value for blue channel.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to turn an image of type `PhotonImage` into a gamma corrected image:
|
|
* use photon_rs::colour_spaces::gamma_correction;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* gamma_correction(&mut img, 2.2, 2.2, 2.2);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} red
|
|
* @param {number} green
|
|
* @param {number} blue
|
|
*/
|
|
export function gamma_correction(photon_image: PhotonImage, red: number, green: number, blue: number): void;
|
|
/**
|
|
* Image manipulation effects in the HSLuv colour space
|
|
*
|
|
* Effects include:
|
|
* * **saturate** - Saturation increase.
|
|
* * **desaturate** - Desaturate the image.
|
|
* * **shift_hue** - Hue rotation by a specified number of degrees.
|
|
* * **darken** - Decrease the brightness.
|
|
* * **lighten** - Increase the brightness.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* * `mode` - The effect desired to be applied. Choose from: `saturate`, `desaturate`, `shift_hue`, `darken`, `lighten`
|
|
* * `amt` - A float value from 0 to 1 which represents the amount the effect should be increased by.
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to increase the saturation by 10%:
|
|
* use photon_rs::colour_spaces::hsluv;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* hsluv(&mut img, "saturate", 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {string} mode
|
|
* @param {number} amt
|
|
*/
|
|
export function hsluv(photon_image: PhotonImage, mode: string, amt: number): void;
|
|
/**
|
|
* Image manipulation effects in the LCh colour space
|
|
*
|
|
* Effects include:
|
|
* * **saturate** - Saturation increase.
|
|
* * **desaturate** - Desaturate the image.
|
|
* * **shift_hue** - Hue rotation by a specified number of degrees.
|
|
* * **darken** - Decrease the brightness.
|
|
* * **lighten** - Increase the brightness.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* * `mode` - The effect desired to be applied. Choose from: `saturate`, `desaturate`, `shift_hue`, `darken`, `lighten`
|
|
* * `amt` - A float value from 0 to 1 which represents the amount the effect should be increased by.
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to increase the saturation by 10%:
|
|
* use photon_rs::colour_spaces::lch;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* lch(&mut img, "saturate", 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {string} mode
|
|
* @param {number} amt
|
|
*/
|
|
export function lch(photon_image: PhotonImage, mode: string, amt: number): void;
|
|
/**
|
|
* Image manipulation effects in the HSL colour space.
|
|
*
|
|
* Effects include:
|
|
* * **saturate** - Saturation increase.
|
|
* * **desaturate** - Desaturate the image.
|
|
* * **shift_hue** - Hue rotation by a specified number of degrees.
|
|
* * **darken** - Decrease the brightness.
|
|
* * **lighten** - Increase the brightness.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* * `mode` - The effect desired to be applied. Choose from: `saturate`, `desaturate`, `shift_hue`, `darken`, `lighten`
|
|
* * `amt` - A float value from 0 to 1 which represents the amount the effect should be increased by.
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to increase the saturation by 10%:
|
|
* use photon_rs::colour_spaces::hsl;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* hsl(&mut img, "saturate", 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {string} mode
|
|
* @param {number} amt
|
|
*/
|
|
export function hsl(photon_image: PhotonImage, mode: string, amt: number): void;
|
|
/**
|
|
* Image manipulation in the HSV colour space.
|
|
*
|
|
* Effects include:
|
|
* * **saturate** - Saturation increase.
|
|
* * **desaturate** - Desaturate the image.
|
|
* * **shift_hue** - Hue rotation by a specified number of degrees.
|
|
* * **darken** - Decrease the brightness.
|
|
* * **lighten** - Increase the brightness.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* * `mode` - The effect desired to be applied. Choose from: `saturate`, `desaturate`, `shift_hue`, `darken`, `lighten`
|
|
* * `amt` - A float value from 0 to 1 which represents the amount the effect should be increased by.
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to increase the saturation by 10%:
|
|
* use photon_rs::colour_spaces::hsv;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* hsv(&mut img, "saturate", 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {string} mode
|
|
* @param {number} amt
|
|
*/
|
|
export function hsv(photon_image: PhotonImage, mode: string, amt: number): void;
|
|
/**
|
|
* Shift hue by a specified number of degrees in the HSL colour space.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `mode` - A float value from 0 to 1 which is the amount to shift the hue by, or hue rotate by.
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to hue rotate/shift the hue by 120 degrees in the HSL colour space:
|
|
* use photon_rs::colour_spaces::hue_rotate_hsl;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* hue_rotate_hsl(&mut img, 120_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} degrees
|
|
*/
|
|
export function hue_rotate_hsl(img: PhotonImage, degrees: number): void;
|
|
/**
|
|
* Shift hue by a specified number of degrees in the HSV colour space.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `mode` - A float value from 0 to 1 which is the amount to shift the hue by, or hue rotate by.
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to hue rotate/shift the hue by 120 degrees in the HSV colour space:
|
|
* use photon_rs::colour_spaces::hue_rotate_hsv;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* hue_rotate_hsv(&mut img, 120_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} degrees
|
|
*/
|
|
export function hue_rotate_hsv(img: PhotonImage, degrees: number): void;
|
|
/**
|
|
* Shift hue by a specified number of degrees in the LCh colour space.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `mode` - A float value from 0 to 1 which is the amount to shift the hue by, or hue rotate by.
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to hue rotate/shift the hue by 120 degrees in the HSL colour space:
|
|
* use photon_rs::colour_spaces::hue_rotate_lch;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* hue_rotate_lch(&mut img, 120_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} degrees
|
|
*/
|
|
export function hue_rotate_lch(img: PhotonImage, degrees: number): void;
|
|
/**
|
|
* Shift hue by a specified number of degrees in the HSLuv colour space.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `mode` - A float value from 0 to 1 which is the amount to shift the hue by, or hue rotate by.
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to hue rotate/shift the hue by 120 degrees in the HSL colour space:
|
|
* use photon_rs::colour_spaces::hue_rotate_hsluv;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* hue_rotate_hsluv(&mut img, 120_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} degrees
|
|
*/
|
|
export function hue_rotate_hsluv(img: PhotonImage, degrees: number): void;
|
|
/**
|
|
* Increase the image's saturation by converting each pixel's colour to the HSL colour space
|
|
* and increasing the colour's saturation.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to increase the saturation by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Increasing saturation by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to increase saturation by 10% in the HSL colour space:
|
|
* use photon_rs::colour_spaces::saturate_hsl;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* saturate_hsl(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function saturate_hsl(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Increase the image's saturation in the LCh colour space.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to increase the saturation by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Increasing saturation by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to increase saturation by 40% in the Lch colour space:
|
|
* use photon_rs::colour_spaces::saturate_lch;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* saturate_lch(&mut img, 0.4_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function saturate_lch(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Increase the image's saturation in the HSLuv colour space.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to increase the saturation by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Increasing saturation by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to increase saturation by 40% in the HSLuv colour space:
|
|
* use photon_rs::colour_spaces::saturate_hsluv;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* saturate_hsluv(&mut img, 0.4_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function saturate_hsluv(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Increase the image's saturation in the HSV colour space.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level by which to increase the saturation by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Increasing saturation by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to increase saturation by 30% in the HSV colour space:
|
|
* use photon_rs::colour_spaces::saturate_hsv;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* saturate_hsv(&mut img, 0.3_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function saturate_hsv(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Lighten an image by a specified amount in the LCh colour space.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to lighten the image by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Lightening by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to lighten an image by 10% in the LCh colour space:
|
|
* use photon_rs::colour_spaces::lighten_lch;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* lighten_lch(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function lighten_lch(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Lighten an image by a specified amount in the HSLuv colour space.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to lighten the image by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Lightening by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to lighten an image by 10% in the HSLuv colour space:
|
|
* use photon_rs::colour_spaces::lighten_hsluv;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* lighten_hsluv(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function lighten_hsluv(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Lighten an image by a specified amount in the HSL colour space.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to lighten the image by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Lightening by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to lighten an image by 10% in the HSL colour space:
|
|
* use photon_rs::colour_spaces::lighten_hsl;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* lighten_hsl(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function lighten_hsl(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Lighten an image by a specified amount in the HSV colour space.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to lighten the image by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Lightening by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to lighten an image by 10% in the HSV colour space:
|
|
* use photon_rs::colour_spaces::lighten_hsv;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* lighten_hsv(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function lighten_hsv(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Darken the image by a specified amount in the LCh colour space.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to darken the image by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Darkening by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to darken an image by 10% in the LCh colour space:
|
|
* use photon_rs::colour_spaces::darken_lch;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* darken_lch(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function darken_lch(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Darken the image by a specified amount in the HSLuv colour space.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to darken the image by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Darkening by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to darken an image by 10% in the HSLuv colour space:
|
|
* use photon_rs::colour_spaces::darken_hsluv;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* darken_hsluv(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function darken_hsluv(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Darken the image by a specified amount in the HSL colour space.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to darken the image by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Darkening by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to darken an image by 10% in the HSL colour space:
|
|
* use photon_rs::colour_spaces::darken_hsl;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* darken_hsl(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function darken_hsl(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Darken the image's colours by a specified amount in the HSV colour space.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to darken the image by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Darkening by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to darken an image by 10% in the HSV colour space:
|
|
* use photon_rs::colour_spaces::darken_hsv;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* darken_hsv(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function darken_hsv(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Desaturate the image by a specified amount in the HSV colour space.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to desaturate the image by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Desaturating by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to desaturate an image by 10% in the HSV colour space:
|
|
* use photon_rs::colour_spaces::desaturate_hsv;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* desaturate_hsv(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function desaturate_hsv(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Desaturate the image by a specified amount in the HSL colour space.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to desaturate the image by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Desaturating by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to desaturate an image by 10% in the LCh colour space:
|
|
* use photon_rs::colour_spaces::desaturate_hsl;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* desaturate_hsl(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function desaturate_hsl(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Desaturate the image by a specified amount in the LCh colour space.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to desaturate the image by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Desaturating by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to desaturate an image by 10% in the LCh colour space:
|
|
* use photon_rs::colour_spaces::desaturate_lch;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* desaturate_lch(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function desaturate_lch(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Desaturate the image by a specified amount in the HSLuv colour space.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `level` - Float value from 0 to 1 representing the level to which to desaturate the image by.
|
|
* The `level` must be from 0 to 1 in floating-point, `f32` format.
|
|
* Desaturating by 80% would be represented by a `level` of 0.8
|
|
*
|
|
* # Example
|
|
* ```no_run
|
|
* // For example to desaturate an image by 10% in the HSLuv colour space:
|
|
* use photon_rs::colour_spaces::desaturate_hsluv;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* desaturate_hsluv(&mut img, 0.1_f32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} level
|
|
*/
|
|
export function desaturate_hsluv(img: PhotonImage, level: number): void;
|
|
/**
|
|
* Mix image with a single color, supporting passing `opacity`.
|
|
* The algorithm comes from Jimp. See `function mix` and `function colorFn` at following link:
|
|
* https://github.com/oliver-moran/jimp/blob/29679faa597228ff2f20d34c5758e4d2257065a3/packages/plugin-color/src/index.js
|
|
* Specifically, result_value = (mix_color_value - origin_value) * opacity + origin_value =
|
|
* mix_color_value * opacity + (1 - opacity) * origin_value for each
|
|
* of RGB channel.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage that contains a view into the image.
|
|
* * `mix_color` - the color to be mixed in, as an RGB value.
|
|
* * `opacity` - the opacity of color when mixed to image. Float value from 0 to 1.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to mix an image with rgb (50, 255, 254) and opacity 0.4:
|
|
* use photon_rs::Rgb;
|
|
* use photon_rs::colour_spaces::mix_with_colour;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mix_colour = Rgb::new(50_u8, 255_u8, 254_u8);
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* mix_with_colour(&mut img, mix_colour, 0.4_f32);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {Rgb} mix_colour
|
|
* @param {number} opacity
|
|
*/
|
|
export function mix_with_colour(photon_image: PhotonImage, mix_colour: Rgb, opacity: number): void;
|
|
/**
|
|
* Noise reduction.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to noise reduct an image:
|
|
* use photon_rs::conv::noise_reduction;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* noise_reduction(&mut img);
|
|
* ```
|
|
* Adds a constant to a select R, G, or B channel's value.
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function noise_reduction(photon_image: PhotonImage): void;
|
|
/**
|
|
* Sharpen an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to sharpen an image:
|
|
* use photon_rs::conv::sharpen;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* sharpen(&mut img);
|
|
* ```
|
|
* Adds a constant to a select R, G, or B channel's value.
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function sharpen(photon_image: PhotonImage): void;
|
|
/**
|
|
* Apply edge detection to an image, to create a dark version with its edges highlighted.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to increase the Red channel for all pixels by 10:
|
|
* use photon_rs::conv::edge_detection;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* edge_detection(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function edge_detection(photon_image: PhotonImage): void;
|
|
/**
|
|
* Apply an identity kernel convolution to an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` -A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply an identity kernel convolution:
|
|
* use photon_rs::conv::identity;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* identity(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function identity(photon_image: PhotonImage): void;
|
|
/**
|
|
* Apply a box blur effect.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply a box blur effect:
|
|
* use photon_rs::conv::box_blur;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* box_blur(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function box_blur(photon_image: PhotonImage): void;
|
|
/**
|
|
* Gaussian blur in linear time.
|
|
*
|
|
* Reference: http://blog.ivank.net/fastest-gaussian-blur.html
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage
|
|
* * `radius` - blur radius
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::conv::gaussian_blur;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* gaussian_blur(&mut img, 3_i32);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} radius
|
|
*/
|
|
export function gaussian_blur(photon_image: PhotonImage, radius: number): void;
|
|
/**
|
|
* Detect horizontal lines in an image, and highlight these only.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to display the horizontal lines in an image:
|
|
* use photon_rs::conv::detect_horizontal_lines;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* detect_horizontal_lines(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function detect_horizontal_lines(photon_image: PhotonImage): void;
|
|
/**
|
|
* Detect vertical lines in an image, and highlight these only.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to display the vertical lines in an image:
|
|
* use photon_rs::conv::detect_vertical_lines;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* detect_vertical_lines(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function detect_vertical_lines(photon_image: PhotonImage): void;
|
|
/**
|
|
* Detect lines at a forty five degree angle in an image, and highlight these only.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to display the lines at a forty five degree angle in an image:
|
|
* use photon_rs::conv::detect_45_deg_lines;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* detect_45_deg_lines(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function detect_45_deg_lines(photon_image: PhotonImage): void;
|
|
/**
|
|
* Detect lines at a 135 degree angle in an image, and highlight these only.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to display the lines at a 135 degree angle in an image:
|
|
* use photon_rs::conv::detect_135_deg_lines;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* detect_135_deg_lines(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function detect_135_deg_lines(photon_image: PhotonImage): void;
|
|
/**
|
|
* Apply a standard laplace convolution.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply a laplace effect:
|
|
* use photon_rs::conv::laplace;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* laplace(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function laplace(photon_image: PhotonImage): void;
|
|
/**
|
|
* Preset edge effect.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply this effect:
|
|
* use photon_rs::conv::edge_one;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* edge_one(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function edge_one(photon_image: PhotonImage): void;
|
|
/**
|
|
* Apply an emboss effect to an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply an emboss effect:
|
|
* use photon_rs::conv::emboss;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* emboss(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function emboss(photon_image: PhotonImage): void;
|
|
/**
|
|
* Apply a horizontal Sobel filter to an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply a horizontal Sobel filter:
|
|
* use photon_rs::conv::sobel_horizontal;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* sobel_horizontal(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function sobel_horizontal(photon_image: PhotonImage): void;
|
|
/**
|
|
* Apply a horizontal Prewitt convolution to an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply a horizontal Prewitt convolution effect:
|
|
* use photon_rs::conv::prewitt_horizontal;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* prewitt_horizontal(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function prewitt_horizontal(photon_image: PhotonImage): void;
|
|
/**
|
|
* Apply a vertical Sobel filter to an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply a vertical Sobel filter:
|
|
* use photon_rs::conv::sobel_vertical;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* sobel_vertical(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function sobel_vertical(photon_image: PhotonImage): void;
|
|
/**
|
|
* Apply a global Sobel filter to an image
|
|
*
|
|
* Each pixel is calculated as the magnitude of the horizontal and vertical components of the Sobel filter,
|
|
* ie if X is the horizontal sobel and Y is the vertical, for each pixel, we calculate sqrt(X^2 + Y^2)
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply a global Sobel filter:
|
|
* use photon_rs::conv::sobel_global;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* sobel_global(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function sobel_global(photon_image: PhotonImage): void;
|
|
/**
|
|
* Add randomized noise to an image.
|
|
* This function adds a Gaussian Noise Sample to each pixel through incrementing each channel by a randomized offset.
|
|
* This randomized offset is generated by creating a randomized thread pool.
|
|
* **[WASM SUPPORT IS AVAILABLE]**: Randomized thread pools cannot be created with WASM, but
|
|
* a workaround using js_sys::Math::random works now.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example:
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::noise::add_noise_rand;
|
|
* use photon_rs::PhotonImage;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* add_noise_rand(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function add_noise_rand(photon_image: PhotonImage): void;
|
|
/**
|
|
* Add pink-tinted noise to an image.
|
|
*
|
|
* **[WASM SUPPORT IS AVAILABLE]**: Randomized thread pools cannot be created with WASM, but
|
|
* a workaround using js_sys::Math::random works now.
|
|
* # Arguments
|
|
* * `name` - A PhotonImage that contains a view into the image.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to add pink-tinted noise to an image:
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::noise::pink_noise;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* pink_noise(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function pink_noise(photon_image: PhotonImage): void;
|
|
/**
|
|
* Add a watermark to an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A DynamicImage that contains a view into the image.
|
|
* * `watermark` - The watermark to be placed onto the `img` image.
|
|
* * `x` - The x coordinate where the watermark's top corner should be positioned.
|
|
* * `y` - The y coordinate where the watermark's top corner should be positioned.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to add a watermark to an image at x: 30, y: 40:
|
|
* use photon_rs::multiple::watermark;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* let water_mark = open_image("watermark.jpg").expect("File should open");
|
|
* watermark(&mut img, &water_mark, 30_i64, 40_i64);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {PhotonImage} watermark
|
|
* @param {bigint} x
|
|
* @param {bigint} y
|
|
*/
|
|
export function watermark(img: PhotonImage, watermark: PhotonImage, x: bigint, y: bigint): void;
|
|
/**
|
|
* Blend two images together.
|
|
*
|
|
* The `blend_mode` (3rd param) determines which blending mode to use; change this for varying effects.
|
|
* The blend modes available include: `overlay`, `over`, `atop`, `xor`, `plus`, `multiply`, `burn`,
|
|
* `difference`, `soft_light`, `screen`, `hard_light`, `dodge`, `exclusion`, `lighten`, `darken` (more to come)
|
|
* NOTE: The first image must be smaller than the second image passed as params.
|
|
* If the first image were larger than the second, then there would be overflowing pixels which would have no corresponding pixels
|
|
* in the second image.
|
|
* # Arguments
|
|
* * `img` - A DynamicImage that contains a view into the image.
|
|
* * `img2` - The 2nd DynamicImage to be blended with the first.
|
|
* * `blend_mode` - The blending mode to use. See above for complete list of blend modes available.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to blend two images with the `multiply` blend mode:
|
|
* use photon_rs::multiple::blend;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* let img2 = open_image("img2.jpg").expect("File should open");
|
|
* blend(&mut img, &img2, "multiply");
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {PhotonImage} photon_image2
|
|
* @param {string} blend_mode
|
|
*/
|
|
export function blend(photon_image: PhotonImage, photon_image2: PhotonImage, blend_mode: string): void;
|
|
/**
|
|
* @param {number} width
|
|
* @param {number} height
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function create_gradient(width: number, height: number): PhotonImage;
|
|
/**
|
|
* Apply a gradient to an image.
|
|
* @param {PhotonImage} image
|
|
*/
|
|
export function apply_gradient(image: PhotonImage): void;
|
|
/**
|
|
* Solarization on the Blue channel.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::neue;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* neue(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function neue(photon_image: PhotonImage): void;
|
|
/**
|
|
* Solarization on the Red and Green channels.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::lix;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* lix(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function lix(photon_image: PhotonImage): void;
|
|
/**
|
|
* Solarization on the Red and Blue channels.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::ryo;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* ryo(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function ryo(photon_image: PhotonImage): void;
|
|
/**
|
|
* Apply a filter to an image. Over 20 filters are available.
|
|
* The filters are as follows:
|
|
* * **oceanic**: Add an aquamarine-tinted hue to an image.
|
|
* * **islands**: Aquamarine tint.
|
|
* * **marine**: Add a green/blue mixed hue to an image.
|
|
* * **seagreen**: Dark green hue, with tones of blue.
|
|
* * **flagblue**: Royal blue tint
|
|
* * **liquid**: Blue-inspired tint.
|
|
* * **diamante**: Custom filter with a blue/turquoise tint.
|
|
* * **radio**: Fallout-style radio effect.
|
|
* * **twenties**: Slight-blue tinted historical effect.
|
|
* * **rosetint**: Rose-tinted filter.
|
|
* * **mauve**: Purple-infused filter.
|
|
* * **bluechrome**: Blue monochrome effect.
|
|
* * **vintage**: Vintage filter with a red tint.
|
|
* * **perfume**: Increase the blue channel, with moderate increases in the Red and Green channels.
|
|
* * **serenity**: Custom filter with an increase in the Blue channel's values.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `filter_name` - The filter's name. Choose from the selection above, eg: "oceanic"
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to add a filter called "vintage" to an image:
|
|
* use photon_rs::filters::filter;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* filter(&mut img, "vintage");
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {string} filter_name
|
|
*/
|
|
export function filter(img: PhotonImage, filter_name: string): void;
|
|
/**
|
|
* Apply a lofi effect to an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::lofi;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* lofi(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function lofi(img: PhotonImage): void;
|
|
/**
|
|
* Apply a rose tint to an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::pastel_pink;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* pastel_pink(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function pastel_pink(img: PhotonImage): void;
|
|
/**
|
|
* Apply a vintage, golden hue to an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::golden;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* golden(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function golden(img: PhotonImage): void;
|
|
/**
|
|
* Increased contrast filter effect.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::cali;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* cali(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function cali(img: PhotonImage): void;
|
|
/**
|
|
* Greyscale effect with increased contrast.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::dramatic;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* dramatic(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function dramatic(img: PhotonImage): void;
|
|
/**
|
|
* Monochrome tint effect with increased contrast
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `rgb_color` - RGB color
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::monochrome_tint;
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::Rgb;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* let rgb_color = Rgb::new(12, 12, 10);
|
|
* monochrome_tint(&mut img, rgb_color);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {Rgb} rgb_color
|
|
*/
|
|
export function monochrome_tint(img: PhotonImage, rgb_color: Rgb): void;
|
|
/**
|
|
* Duotone effect with blue and purple tones.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::duotone_violette;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* duotone_violette(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function duotone_violette(img: PhotonImage): void;
|
|
/**
|
|
* Duotone effect with purple tones.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::duotone_horizon;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* duotone_horizon(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function duotone_horizon(img: PhotonImage): void;
|
|
/**
|
|
* A duotone filter with a user-specified color and a gray color
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `rgb_color` - RGB color
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::duotone_tint;
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::Rgb;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* let rgb_color = Rgb::new(12, 12, 10);
|
|
* duotone_tint(&mut img, rgb_color);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {Rgb} rgb_color
|
|
*/
|
|
export function duotone_tint(img: PhotonImage, rgb_color: Rgb): void;
|
|
/**
|
|
* Duotone effect with a lilac hue
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::duotone_lilac;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* duotone_lilac(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function duotone_lilac(img: PhotonImage): void;
|
|
/**
|
|
* A duotone ochre tint effect
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::duotone_ochre;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* duotone_ochre(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function duotone_ochre(img: PhotonImage): void;
|
|
/**
|
|
* Apply a red hue, with increased contrast and brightness.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::firenze;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* firenze(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function firenze(img: PhotonImage): void;
|
|
/**
|
|
* Apply a greyscale effect with increased contrast.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::filters::obsidian;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* obsidian(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function obsidian(img: PhotonImage): void;
|
|
/**
|
|
* Crop an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to crop an image at (0, 0) to (500, 800)
|
|
* use photon_rs::native::{open_image};
|
|
* use photon_rs::transform::crop;
|
|
* use photon_rs::PhotonImage;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* let cropped_img: PhotonImage = crop(&img, 0_u32, 0_u32, 500_u32, 800_u32);
|
|
* // Write the contents of this image in JPG format.
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} x1
|
|
* @param {number} y1
|
|
* @param {number} x2
|
|
* @param {number} y2
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function crop(photon_image: PhotonImage, x1: number, y1: number, x2: number, y2: number): PhotonImage;
|
|
/**
|
|
* @param {HTMLCanvasElement} source_canvas
|
|
* @param {number} width
|
|
* @param {number} height
|
|
* @param {number} left
|
|
* @param {number} top
|
|
* @returns {HTMLCanvasElement}
|
|
*/
|
|
export function crop_img_browser(source_canvas: HTMLCanvasElement, width: number, height: number, left: number, top: number): HTMLCanvasElement;
|
|
/**
|
|
* Flip an image horizontally.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to flip an image horizontally:
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::transform::fliph;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* fliph(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function fliph(photon_image: PhotonImage): void;
|
|
/**
|
|
* Flip an image vertically.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to flip an image vertically:
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::transform::flipv;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* flipv(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function flipv(photon_image: PhotonImage): void;
|
|
/**
|
|
* Resize an image on the web.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `width` - New width.
|
|
* * `height` - New height.
|
|
* * `sampling_filter` - Nearest = 1, Triangle = 2, CatmullRom = 3, Gaussian = 4, Lanczos3 = 5
|
|
* @param {PhotonImage} photon_img
|
|
* @param {number} width
|
|
* @param {number} height
|
|
* @param {SamplingFilter} sampling_filter
|
|
* @returns {HTMLCanvasElement}
|
|
*/
|
|
export function resize_img_browser(photon_img: PhotonImage, width: number, height: number, sampling_filter: SamplingFilter): HTMLCanvasElement;
|
|
/**
|
|
* Resize an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `width` - New width.
|
|
* * `height` - New height.
|
|
* * `sampling_filter` - Nearest = 1, Triangle = 2, CatmullRom = 3, Gaussian = 4, Lanczos3 = 5
|
|
* @param {PhotonImage} photon_img
|
|
* @param {number} width
|
|
* @param {number} height
|
|
* @param {SamplingFilter} sampling_filter
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function resize(photon_img: PhotonImage, width: number, height: number, sampling_filter: SamplingFilter): PhotonImage;
|
|
/**
|
|
* Resize image using seam carver.
|
|
* Resize only if new dimensions are smaller, than original image.
|
|
* # NOTE: This is still experimental feature, and pretty slow.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage.
|
|
* * `width` - New width.
|
|
* * `height` - New height.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, resize image using seam carver:
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::transform::seam_carve;
|
|
* use photon_rs::PhotonImage;
|
|
*
|
|
* let img = open_image("img.jpg").expect("File should open");
|
|
* let result: PhotonImage = seam_carve(&img, 100_u32, 100_u32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} width
|
|
* @param {number} height
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function seam_carve(img: PhotonImage, width: number, height: number): PhotonImage;
|
|
/**
|
|
* Shear the image along the X axis.
|
|
* A sheared PhotonImage is returned.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage. See the PhotonImage struct for details.
|
|
* * `shear` - Amount to shear.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to shear an image by 0.5:
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::transform::shearx;
|
|
*
|
|
* let img = open_image("img.jpg").expect("File should open");
|
|
* let sheared_img = shearx(&img, 0.5);
|
|
* ```
|
|
* @param {PhotonImage} photon_img
|
|
* @param {number} shear
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function shearx(photon_img: PhotonImage, shear: number): PhotonImage;
|
|
/**
|
|
* Shear the image along the Y axis.
|
|
* A sheared PhotonImage is returned.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage. See the PhotonImage struct for details.
|
|
* * `shear` - Amount to shear.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to shear an image by 0.5:
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::transform::sheary;
|
|
*
|
|
* let img = open_image("img.jpg").expect("File should open");
|
|
* let sheared_img = sheary(&img, 0.5);
|
|
* ```
|
|
* @param {PhotonImage} photon_img
|
|
* @param {number} shear
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function sheary(photon_img: PhotonImage, shear: number): PhotonImage;
|
|
/**
|
|
* Apply uniform padding around the PhotonImage
|
|
* A padded PhotonImage is returned.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage. See the PhotonImage struct for details.
|
|
* * `padding` - The amount of padding to be applied to the PhotonImage.
|
|
* * `padding_rgba` - Tuple containing the RGBA code for padding color.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply a padding of 10 pixels around a PhotonImage:
|
|
* use photon_rs::transform::padding_uniform;
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::Rgba;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* let rgba = Rgba::new(200_u8, 100_u8, 150_u8, 255_u8);
|
|
* padding_uniform(&img, 10_u32, rgba);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} padding
|
|
* @param {Rgba} padding_rgba
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function padding_uniform(img: PhotonImage, padding: number, padding_rgba: Rgba): PhotonImage;
|
|
/**
|
|
* Apply padding on the left side of the PhotonImage
|
|
* A padded PhotonImage is returned.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage. See the PhotonImage struct for details.
|
|
* * `padding` - The amount of padding to be applied to the PhotonImage.
|
|
* * `padding_rgba` - Tuple containing the RGBA code for padding color.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply a padding of 10 pixels on the left side of a PhotonImage:
|
|
* use photon_rs::transform::padding_left;
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::Rgba;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* let rgba = Rgba::new(200_u8, 100_u8, 150_u8, 255_u8);
|
|
* padding_left(&img, 10_u32, rgba);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} padding
|
|
* @param {Rgba} padding_rgba
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function padding_left(img: PhotonImage, padding: number, padding_rgba: Rgba): PhotonImage;
|
|
/**
|
|
* Apply padding on the left side of the PhotonImage
|
|
* A padded PhotonImage is returned.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage. See the PhotonImage struct for details.
|
|
* * `padding` - The amount of padding to be applied to the PhotonImage.
|
|
* * `padding_rgba` - Tuple containing the RGBA code for padding color.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply a padding of 10 pixels on the right side of a PhotonImage:
|
|
* use photon_rs::transform::padding_right;
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::Rgba;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* let rgba = Rgba::new(200_u8, 100_u8, 150_u8, 255_u8);
|
|
* padding_right(&img, 10_u32, rgba);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} padding
|
|
* @param {Rgba} padding_rgba
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function padding_right(img: PhotonImage, padding: number, padding_rgba: Rgba): PhotonImage;
|
|
/**
|
|
* Apply padding on the left side of the PhotonImage
|
|
* A padded PhotonImage is returned.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage. See the PhotonImage struct for details.
|
|
* * `padding` - The amount of padding to be applied to the PhotonImage.
|
|
* * `padding_rgba` - Tuple containing the RGBA code for padding color.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply a padding of 10 pixels on the top of a PhotonImage:
|
|
* use photon_rs::transform::padding_top;
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::Rgba;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* let rgba = Rgba::new(200_u8, 100_u8, 150_u8, 255_u8);
|
|
* padding_top(&img, 10_u32, rgba);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} padding
|
|
* @param {Rgba} padding_rgba
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function padding_top(img: PhotonImage, padding: number, padding_rgba: Rgba): PhotonImage;
|
|
/**
|
|
* Apply padding on the left side of the PhotonImage
|
|
* A padded PhotonImage is returned.
|
|
* # Arguments
|
|
* * `img` - A PhotonImage. See the PhotonImage struct for details.
|
|
* * `padding` - The amount of padding to be applied to the PhotonImage.
|
|
* * `padding_rgba` - Tuple containing the RGBA code for padding color.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to apply a padding of 10 pixels on the bottom of a PhotonImage:
|
|
* use photon_rs::transform::padding_bottom;
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::Rgba;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* let rgba = Rgba::new(200_u8, 100_u8, 150_u8, 255_u8);
|
|
* padding_bottom(&img, 10_u32, rgba);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} padding
|
|
* @param {Rgba} padding_rgba
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function padding_bottom(img: PhotonImage, padding: number, padding_rgba: Rgba): PhotonImage;
|
|
/**
|
|
* Rotate the PhotonImage on an arbitrary angle
|
|
* A rotated PhotonImage is returned.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage. See the PhotonImage struct for details.
|
|
* * `angle` - Rotation angle in degrees.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to rotate a PhotonImage by 30 degrees:
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::transform::rotate;
|
|
*
|
|
* let img = open_image("img.jpg").expect("File should open");
|
|
* let rotated_img = rotate(&img, 30.0);
|
|
* ```
|
|
* @param {PhotonImage} photon_img
|
|
* @param {number} angle
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function rotate(photon_img: PhotonImage, angle: number): PhotonImage;
|
|
/**
|
|
* Resample the PhotonImage.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage. See the PhotonImage struct for details.
|
|
* * `dst_width` - Target width.
|
|
* * `dst_height` - Target height.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to resample a PhotonImage to 1920x1080 size:
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::transform::resample;
|
|
*
|
|
* let img = open_image("img.jpg").expect("File should open");
|
|
* let rotated_img = resample(&img, 1920, 1080);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} dst_width
|
|
* @param {number} dst_height
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function resample(img: PhotonImage, dst_width: number, dst_height: number): PhotonImage;
|
|
/**
|
|
* Adds an offset to the image by a certain number of pixels.
|
|
*
|
|
* This creates an RGB shift effect.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `channel_index`: The index of the channel to increment. 0 for red, 1 for green and 2 for blue.
|
|
* * `offset` - The offset is added to the pixels in the image.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to offset pixels by 30 pixels on the red channel:
|
|
* use photon_rs::effects::offset;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* offset(&mut img, 0_usize, 30_u32);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} channel_index
|
|
* @param {number} offset
|
|
*/
|
|
export function offset(photon_image: PhotonImage, channel_index: number, offset: number): void;
|
|
/**
|
|
* Adds an offset to the red channel by a certain number of pixels.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `offset` - The offset you want to move the red channel by.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to add an offset to the red channel by 30 pixels.
|
|
* use photon_rs::effects::offset_red;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* offset_red(&mut img, 30_u32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} offset_amt
|
|
*/
|
|
export function offset_red(img: PhotonImage, offset_amt: number): void;
|
|
/**
|
|
* Adds an offset to the green channel by a certain number of pixels.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `offset` - The offset you want to move the green channel by.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to add an offset to the green channel by 30 pixels.
|
|
* use photon_rs::effects::offset_green;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* offset_green(&mut img, 30_u32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} offset_amt
|
|
*/
|
|
export function offset_green(img: PhotonImage, offset_amt: number): void;
|
|
/**
|
|
* Adds an offset to the blue channel by a certain number of pixels.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `offset_amt` - The offset you want to move the blue channel by.
|
|
* # Example
|
|
* // For example, to add an offset to the green channel by 40 pixels.
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::effects::offset_blue;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* offset_blue(&mut img, 40_u32);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
* @param {number} offset_amt
|
|
*/
|
|
export function offset_blue(img: PhotonImage, offset_amt: number): void;
|
|
/**
|
|
* Adds multiple offsets to the image by a certain number of pixels (on two channels).
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `offset` - The offset is added to the pixels in the image.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to add a 30-pixel offset to both the red and blue channels:
|
|
* use photon_rs::effects::multiple_offsets;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* multiple_offsets(&mut img, 30_u32, 0_usize, 2_usize);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} offset
|
|
* @param {number} channel_index
|
|
* @param {number} channel_index2
|
|
*/
|
|
export function multiple_offsets(photon_image: PhotonImage, offset: number, channel_index: number, channel_index2: number): void;
|
|
/**
|
|
* Halftoning effect.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example:
|
|
* use photon_rs::effects::halftone;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* halftone(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function halftone(photon_image: PhotonImage): void;
|
|
/**
|
|
* Reduces an image to the primary colours.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to add a primary colour effect to an image of type `DynamicImage`:
|
|
* use photon_rs::effects::primary;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* primary(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} img
|
|
*/
|
|
export function primary(img: PhotonImage): void;
|
|
/**
|
|
* Colorizes the green channels of the image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to colorize an image of type `PhotonImage`:
|
|
* use photon_rs::effects::colorize;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* colorize(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function colorize(photon_image: PhotonImage): void;
|
|
/**
|
|
* Applies a solarizing effect to an image.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to colorize an image of type `PhotonImage`:
|
|
* use photon_rs::effects::solarize;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* solarize(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function solarize(photon_image: PhotonImage): void;
|
|
/**
|
|
* Applies a solarizing effect to an image and returns the resulting PhotonImage.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to solarize "retimg" an image of type `PhotonImage`:
|
|
* use photon_rs::effects::solarize_retimg;
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::PhotonImage;
|
|
*
|
|
* let img = open_image("img.jpg").expect("File should open");
|
|
* let result: PhotonImage = solarize_retimg(&img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function solarize_retimg(photon_image: PhotonImage): PhotonImage;
|
|
/**
|
|
* Adjust the brightness of an image by a factor.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `brightness` - A u8 to add or subtract to the brightness. To increase
|
|
* the brightness, pass a positive number (up to 255). To decrease the brightness,
|
|
* pass a negative number instead.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::effects::adjust_brightness;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* adjust_brightness(&mut img, 10_i16);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} brightness
|
|
*/
|
|
export function adjust_brightness(photon_image: PhotonImage, brightness: number): void;
|
|
/**
|
|
* Increase the brightness of an image by a constant.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `brightness` - A u8 to add to the brightness.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::effects::inc_brightness;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* inc_brightness(&mut img, 10_u8);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} brightness
|
|
*/
|
|
export function inc_brightness(photon_image: PhotonImage, brightness: number): void;
|
|
/**
|
|
* Decrease the brightness of an image by a constant.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `brightness` - A u8 to subtract from the brightness. It should be a positive number,
|
|
* and this value will then be subtracted from the brightness.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::effects::dec_brightness;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* dec_brightness(&mut img, 10_u8);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} brightness
|
|
*/
|
|
export function dec_brightness(photon_image: PhotonImage, brightness: number): void;
|
|
/**
|
|
* Adjust the contrast of an image by a factor.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage that contains a view into the image.
|
|
* * `contrast` - An f32 factor used to adjust contrast. Between [-255.0, 255.0]. The algorithm will
|
|
* clamp results if passed factor is out of range.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* use photon_rs::effects::adjust_contrast;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* adjust_contrast(&mut img, 30_f32);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} contrast
|
|
*/
|
|
export function adjust_contrast(photon_image: PhotonImage, contrast: number): void;
|
|
/**
|
|
* Tint an image by adding an offset to averaged RGB channel values.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `r_offset` - The amount the R channel should be incremented by.
|
|
* * `g_offset` - The amount the G channel should be incremented by.
|
|
* * `b_offset` - The amount the B channel should be incremented by.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to tint an image of type `PhotonImage`:
|
|
* use photon_rs::effects::tint;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* tint(&mut img, 10_u32, 20_u32, 15_u32);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} r_offset
|
|
* @param {number} g_offset
|
|
* @param {number} b_offset
|
|
*/
|
|
export function tint(photon_image: PhotonImage, r_offset: number, g_offset: number, b_offset: number): void;
|
|
/**
|
|
* Horizontal strips. Divide an image into a series of equal-height strips, for an artistic effect.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `num_strips` - The number of strips
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to draw horizontal strips on a `PhotonImage`:
|
|
* use photon_rs::effects::horizontal_strips;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* horizontal_strips(&mut img, 8u8);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} num_strips
|
|
*/
|
|
export function horizontal_strips(photon_image: PhotonImage, num_strips: number): void;
|
|
/**
|
|
* Horizontal strips. Divide an image into a series of equal-width strips, for an artistic effect. Sepcify a color as well.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `num_strips` - The numbder of strips
|
|
* * `color` - Color of strips.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to draw blue horizontal strips on a `PhotonImage`:
|
|
* use photon_rs::effects::color_horizontal_strips;
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::Rgb;
|
|
*
|
|
* let color = Rgb::new(255u8, 0u8, 0u8);
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* color_horizontal_strips(&mut img, 8u8, color);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} num_strips
|
|
* @param {Rgb} color
|
|
*/
|
|
export function color_horizontal_strips(photon_image: PhotonImage, num_strips: number, color: Rgb): void;
|
|
/**
|
|
* Vertical strips. Divide an image into a series of equal-width strips, for an artistic effect.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `num_strips` - The numbder of strips
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to draw vertical strips on a `PhotonImage`:
|
|
* use photon_rs::effects::vertical_strips;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* vertical_strips(&mut img, 8u8);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} num_strips
|
|
*/
|
|
export function vertical_strips(photon_image: PhotonImage, num_strips: number): void;
|
|
/**
|
|
* Vertical strips. Divide an image into a series of equal-width strips, for an artistic effect. Sepcify a color as well.
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `num_strips` - The numbder of strips
|
|
* * `color` - Color of strips.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to draw red vertical strips on a `PhotonImage`:
|
|
* use photon_rs::effects::color_vertical_strips;
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::Rgb;
|
|
*
|
|
* let color = Rgb::new(255u8, 0u8, 0u8);
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* color_vertical_strips(&mut img, 8u8, color);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} num_strips
|
|
* @param {Rgb} color
|
|
*/
|
|
export function color_vertical_strips(photon_image: PhotonImage, num_strips: number, color: Rgb): void;
|
|
/**
|
|
* Turn an image into an oil painting
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* * `radius` - Radius of each paint particle
|
|
* * `intesnity` - How artsy an Image should be
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to oil an image of type `PhotonImage`:
|
|
* use photon_rs::effects::oil;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* oil(&mut img, 4i32, 55.0);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} radius
|
|
* @param {number} intensity
|
|
*/
|
|
export function oil(photon_image: PhotonImage, radius: number, intensity: number): void;
|
|
/**
|
|
* Turn an image into an frosted glass see through
|
|
*
|
|
* # Arguments
|
|
* * `img` - A PhotonImage that contains a view into the image.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to turn an image of type `PhotonImage` into frosted glass see through:
|
|
* use photon_rs::effects::frosted_glass;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* frosted_glass(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function frosted_glass(photon_image: PhotonImage): void;
|
|
/**
|
|
* Pixelize an image.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage that contains a view into the image.
|
|
* * `pixel_size` - Targeted pixel size of generated image.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to turn an image of type `PhotonImage` into a pixelized image with 50 pixels blocks:
|
|
* use photon_rs::effects::pixelize;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* pixelize(&mut img, 50);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} pixel_size
|
|
*/
|
|
export function pixelize(photon_image: PhotonImage, pixel_size: number): void;
|
|
/**
|
|
* Normalizes an image by remapping its range of pixels values. Only RGB
|
|
* channels are processed and each channel is stretched to \[0, 255\] range
|
|
* independently. This process is also known as contrast stretching.
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage that contains a view into the image.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to turn an image of type `PhotonImage` into a normalized image:
|
|
* use photon_rs::effects::normalize;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* normalize(&mut img);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
*/
|
|
export function normalize(photon_image: PhotonImage): void;
|
|
/**
|
|
* Applies Floyd-Steinberg dithering to an image.
|
|
* Only RGB channels are processed, alpha remains unchanged.
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage that contains a view into the image.
|
|
* * `depth` - bits per channel. Clamped between 1 and 8.
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example, to turn an image of type `PhotonImage` into a dithered image:
|
|
* use photon_rs::effects::dither;
|
|
* use photon_rs::native::open_image;
|
|
*
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* let depth = 1;
|
|
* dither(&mut img, depth);
|
|
* ```
|
|
* @param {PhotonImage} photon_image
|
|
* @param {number} depth
|
|
*/
|
|
export function dither(photon_image: PhotonImage, depth: number): void;
|
|
/**
|
|
* @param {PhotonImage} photon_image
|
|
* @param {Rgb} color_a
|
|
* @param {Rgb} color_b
|
|
*/
|
|
export function duotone(photon_image: PhotonImage, color_a: Rgb, color_b: Rgb): void;
|
|
/**
|
|
* Add bordered-text to an image.
|
|
* The only font available as of now is Roboto.
|
|
* Note: A graphic design/text-drawing library is currently being developed, so stay tuned.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* * `text` - Text string to be drawn to the image.
|
|
* * `x` - x-coordinate of where first letter's 1st pixel should be drawn.
|
|
* * `y` - y-coordinate of where first letter's 1st pixel should be drawn.
|
|
* * `font_size` - Font size in pixels of the text to be drawn.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example to draw the string "Welcome to Photon!" at 10, 10:
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::text::draw_text_with_border;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* draw_text_with_border(&mut img, "Welcome to Photon!", 10_i32, 10_i32, 90_f32);
|
|
* ```
|
|
* @param {PhotonImage} photon_img
|
|
* @param {string} text
|
|
* @param {number} x
|
|
* @param {number} y
|
|
* @param {number} font_size
|
|
*/
|
|
export function draw_text_with_border(photon_img: PhotonImage, text: string, x: number, y: number, font_size: number): void;
|
|
/**
|
|
* Add text to an image.
|
|
* The only font available as of now is Roboto.
|
|
* Note: A graphic design/text-drawing library is currently being developed, so stay tuned.
|
|
*
|
|
* # Arguments
|
|
* * `photon_image` - A PhotonImage.
|
|
* * `text` - Text string to be drawn to the image.
|
|
* * `x` - x-coordinate of where first letter's 1st pixel should be drawn.
|
|
* * `y` - y-coordinate of where first letter's 1st pixel should be drawn.
|
|
* * `font_size` - Font size in pixels of the text to be drawn.
|
|
*
|
|
* # Example
|
|
*
|
|
* ```no_run
|
|
* // For example to draw the string "Welcome to Photon!" at 10, 10:
|
|
* use photon_rs::native::open_image;
|
|
* use photon_rs::text::draw_text;
|
|
*
|
|
* // Open the image. A PhotonImage is returned.
|
|
* let mut img = open_image("img.jpg").expect("File should open");
|
|
* draw_text(&mut img, "Welcome to Photon!", 10_i32, 10_i32, 90_f32);
|
|
* ```
|
|
* @param {PhotonImage} photon_img
|
|
* @param {string} text
|
|
* @param {number} x
|
|
* @param {number} y
|
|
* @param {number} font_size
|
|
*/
|
|
export function draw_text(photon_img: PhotonImage, text: string, x: number, y: number, font_size: number): void;
|
|
/**
|
|
*! [temp] Check if WASM is supported.
|
|
*/
|
|
export function run(): void;
|
|
/**
|
|
* Get the ImageData from a 2D canvas context
|
|
* @param {HTMLCanvasElement} canvas
|
|
* @param {CanvasRenderingContext2D} ctx
|
|
* @returns {ImageData}
|
|
*/
|
|
export function get_image_data(canvas: HTMLCanvasElement, ctx: CanvasRenderingContext2D): ImageData;
|
|
/**
|
|
* Place a PhotonImage onto a 2D canvas.
|
|
* @param {HTMLCanvasElement} canvas
|
|
* @param {CanvasRenderingContext2D} ctx
|
|
* @param {PhotonImage} new_image
|
|
*/
|
|
export function putImageData(canvas: HTMLCanvasElement, ctx: CanvasRenderingContext2D, new_image: PhotonImage): void;
|
|
/**
|
|
* Convert a HTML5 Canvas Element to a PhotonImage.
|
|
*
|
|
* This converts the ImageData found in the canvas context to a PhotonImage,
|
|
* which can then have effects or filters applied to it.
|
|
* @param {HTMLCanvasElement} canvas
|
|
* @param {CanvasRenderingContext2D} ctx
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function open_image(canvas: HTMLCanvasElement, ctx: CanvasRenderingContext2D): PhotonImage;
|
|
/**
|
|
* Convert ImageData to a raw pixel vec of u8s.
|
|
* @param {ImageData} imgdata
|
|
* @returns {Uint8Array}
|
|
*/
|
|
export function to_raw_pixels(imgdata: ImageData): Uint8Array;
|
|
/**
|
|
* Convert a base64 string to a PhotonImage.
|
|
* @param {string} base64
|
|
* @returns {PhotonImage}
|
|
*/
|
|
export function base64_to_image(base64: string): PhotonImage;
|
|
/**
|
|
* Convert a base64 string to a Vec of u8s.
|
|
* @param {string} base64
|
|
* @returns {Uint8Array}
|
|
*/
|
|
export function base64_to_vec(base64: string): Uint8Array;
|
|
/**
|
|
* Convert a PhotonImage to JS-compatible ImageData.
|
|
* @param {PhotonImage} photon_image
|
|
* @returns {ImageData}
|
|
*/
|
|
export function to_image_data(photon_image: PhotonImage): ImageData;
|
|
export enum SamplingFilter {
|
|
Nearest = 1,
|
|
Triangle = 2,
|
|
CatmullRom = 3,
|
|
Gaussian = 4,
|
|
Lanczos3 = 5,
|
|
}
|
|
/**
|
|
* Provides the image's height, width, and contains the image's raw pixels.
|
|
* For use when communicating between JS and WASM, and also natively.
|
|
*/
|
|
export class PhotonImage {
|
|
free(): void;
|
|
/**
|
|
* Create a new PhotonImage from a Vec of u8s, which represent raw pixels.
|
|
* @param {Uint8Array} raw_pixels
|
|
* @param {number} width
|
|
* @param {number} height
|
|
*/
|
|
constructor(raw_pixels: Uint8Array, width: number, height: number);
|
|
/**
|
|
* Create a new PhotonImage from a base64 string.
|
|
* @param {string} base64
|
|
* @returns {PhotonImage}
|
|
*/
|
|
static new_from_base64(base64: string): PhotonImage;
|
|
/**
|
|
* Create a new PhotonImage from a byteslice.
|
|
* @param {Uint8Array} vec
|
|
* @returns {PhotonImage}
|
|
*/
|
|
static new_from_byteslice(vec: Uint8Array): PhotonImage;
|
|
/**
|
|
* Create a new PhotonImage from a Blob/File.
|
|
* @param {Blob} blob
|
|
* @returns {PhotonImage}
|
|
*/
|
|
static new_from_blob(blob: Blob): PhotonImage;
|
|
/**
|
|
* Create a new PhotonImage from a HTMLImageElement
|
|
* @param {HTMLImageElement} image
|
|
* @returns {PhotonImage}
|
|
*/
|
|
static new_from_image(image: HTMLImageElement): PhotonImage;
|
|
/**
|
|
* Get the width of the PhotonImage.
|
|
* @returns {number}
|
|
*/
|
|
get_width(): number;
|
|
/**
|
|
* Get the PhotonImage's pixels as a Vec of u8s.
|
|
* @returns {Uint8Array}
|
|
*/
|
|
get_raw_pixels(): Uint8Array;
|
|
/**
|
|
* Get the height of the PhotonImage.
|
|
* @returns {number}
|
|
*/
|
|
get_height(): number;
|
|
/**
|
|
* Convert the PhotonImage to base64.
|
|
* @returns {string}
|
|
*/
|
|
get_base64(): string;
|
|
/**
|
|
* Convert the PhotonImage to raw bytes. Returns PNG.
|
|
* @returns {Uint8Array}
|
|
*/
|
|
get_bytes(): Uint8Array;
|
|
/**
|
|
* Convert the PhotonImage to raw bytes. Returns a JPEG.
|
|
* @param {number} quality
|
|
* @returns {Uint8Array}
|
|
*/
|
|
get_bytes_jpeg(quality: number): Uint8Array;
|
|
/**
|
|
* Convert the PhotonImage to raw bytes. Returns a WEBP.
|
|
* @returns {Uint8Array}
|
|
*/
|
|
get_bytes_webp(): Uint8Array;
|
|
/**
|
|
* Convert the PhotonImage's raw pixels to JS-compatible ImageData.
|
|
* @returns {ImageData}
|
|
*/
|
|
get_image_data(): ImageData;
|
|
/**
|
|
* Convert ImageData to raw pixels, and update the PhotonImage's raw pixels to this.
|
|
* @param {ImageData} img_data
|
|
*/
|
|
set_imgdata(img_data: ImageData): void;
|
|
/**
|
|
* Calculates estimated filesize and returns number of bytes
|
|
* @returns {bigint}
|
|
*/
|
|
get_estimated_filesize(): bigint;
|
|
}
|
|
/**
|
|
* RGB color type.
|
|
*/
|
|
export class Rgb {
|
|
free(): void;
|
|
/**
|
|
* Create a new RGB struct.
|
|
* @param {number} r
|
|
* @param {number} g
|
|
* @param {number} b
|
|
*/
|
|
constructor(r: number, g: number, b: number);
|
|
/**
|
|
* Set the Red value.
|
|
* @param {number} r
|
|
*/
|
|
set_red(r: number): void;
|
|
/**
|
|
* Get the Green value.
|
|
* @param {number} g
|
|
*/
|
|
set_green(g: number): void;
|
|
/**
|
|
* Set the Blue value.
|
|
* @param {number} b
|
|
*/
|
|
set_blue(b: number): void;
|
|
/**
|
|
* Get the Red value.
|
|
* @returns {number}
|
|
*/
|
|
get_red(): number;
|
|
/**
|
|
* Get the Green value.
|
|
* @returns {number}
|
|
*/
|
|
get_green(): number;
|
|
/**
|
|
* Get the Blue value.
|
|
* @returns {number}
|
|
*/
|
|
get_blue(): number;
|
|
}
|
|
/**
|
|
* RGBA color type.
|
|
*/
|
|
export class Rgba {
|
|
free(): void;
|
|
/**
|
|
* Create a new RGBA struct.
|
|
* @param {number} r
|
|
* @param {number} g
|
|
* @param {number} b
|
|
* @param {number} a
|
|
*/
|
|
constructor(r: number, g: number, b: number, a: number);
|
|
/**
|
|
* Set the Red value.
|
|
* @param {number} r
|
|
*/
|
|
set_red(r: number): void;
|
|
/**
|
|
* Get the Green value.
|
|
* @param {number} g
|
|
*/
|
|
set_green(g: number): void;
|
|
/**
|
|
* Set the Blue value.
|
|
* @param {number} b
|
|
*/
|
|
set_blue(b: number): void;
|
|
/**
|
|
* Set the alpha value.
|
|
* @param {number} a
|
|
*/
|
|
set_alpha(a: number): void;
|
|
/**
|
|
* Get the Red value.
|
|
* @returns {number}
|
|
*/
|
|
get_red(): number;
|
|
/**
|
|
* Get the Green value.
|
|
* @returns {number}
|
|
*/
|
|
get_green(): number;
|
|
/**
|
|
* Get the Blue value.
|
|
* @returns {number}
|
|
*/
|
|
get_blue(): number;
|
|
/**
|
|
* Get the alpha value for this color.
|
|
* @returns {number}
|
|
*/
|
|
get_alpha(): number;
|
|
}
|