View Source Exray.Textures.Image.Loading (Exray v0.6.0)

Handles the loading, conversion and export of Image types

Summary

Functions

export_image(image, file_name)

Export image data to file, returns true on success

export_image_as_code(image, file_name)

Export image as code file defining an array of bytes, returns true on success

export_image_to_memory(image, file_type, file_size)

Export image to memory buffer

image_is_ready?(image)

Check if an image is ready

load_image_anim(file_name, frames)

Load image sequence from file (frames appended to image.data)

load_image_from_memory(file_type, file_data, data_size)

Load image from memory buffer, fileType refers to extension: i.e. '.png'

load_image_from_screen()

Load image from screen buffer and (screenshot)

load_image_from_texture(texture)

Load image from GPU texture data

load_image_raw(file_name, width, height, format, header_size)

Load image from RAW file data

load_image_svg(file_name_or_string, width, height)

Load image from SVG file data or string with specified size

unload_image(image)

Unload image from CPU memory (RAM)

Functions

export_image(image, file_name)

@spec export_image(image :: Exray.Structs.Image.t(), file_name :: binary()) ::
  exported :: boolean()

Export image data to file, returns true on success

export_image_as_code(image, file_name)

@spec export_image_as_code(image :: Exray.Structs.Image.t(), file_name :: binary()) ::
  exported :: boolean()

Export image as code file defining an array of bytes, returns true on success

export_image_to_memory(image, file_type, file_size)

@spec export_image_to_memory(
  image :: Exray.Structs.Image.t(),
  file_type :: binary(),
  file_size :: [integer()]
) :: buffer :: binary()

Export image to memory buffer

image_is_ready?(image)

@spec image_is_ready?(image :: Exray.Structs.Image.t()) :: image_is_ready :: boolean()

Check if an image is ready

load_image_anim(file_name, frames)

@spec load_image_anim(file_name :: binary(), frames :: [integer()]) ::
  image :: Exray.Structs.Image.t()

Load image sequence from file (frames appended to image.data)

load_image_from_memory(file_type, file_data, data_size)

@spec load_image_from_memory(
  file_type :: binary(),
  file_data :: binary(),
  data_size :: integer()
) ::
  image :: Exray.Structs.Image.t()

Load image from memory buffer, fileType refers to extension: i.e. '.png'

load_image_from_screen()

@spec load_image_from_screen() :: image :: Exray.Structs.Image.t()

Load image from screen buffer and (screenshot)

load_image_from_texture(texture)

@spec load_image_from_texture(texture :: Exray.Structs.Texture.t()) ::
  image :: Exray.Structs.Image.t()

Load image from GPU texture data

load_image_raw(file_name, width, height, format, header_size)

@spec load_image_raw(
  file_name :: binary(),
  width :: integer(),
  height :: integer(),
  format :: integer(),
  header_size :: integer()
) :: image :: Exray.Structs.Image.t()

Load image from RAW file data

load_image_svg(file_name_or_string, width, height)

@spec load_image_svg(
  file_name_or_string :: binary(),
  width :: integer(),
  height :: integer()
) ::
  image :: Exray.Structs.Image.t()

Load image from SVG file data or string with specified size

unload_image(image)

@spec unload_image(image :: Exray.Structs.Image.t()) :: :ok

Unload image from CPU memory (RAM)