struct

Athena::ImageSize::Image

Inherits Struct < Value < Object

Represents information related to a processed image.

pp AIS::Image.from_file_path "spec/images/jpeg/436x429_8_3.jpeg" # =>
# Athena::ImageSize::Image(
# @bits=8,
# @channels=3,
# @format=JPEG,
# @height=429,
# @width=436)

Constructors

from_file_path(path : String | Path) : self

Attempts to process the image at the provided path, raising an exception if either the images fails to process or is an unsupported format.

Source
from_io(io : IO) : self

Attempts to process the image from the provided io, raising an exception if either the images fails to process or is an unsupported format.

Source

Class methods

from_file_path?(path : String | Path) : self | Nil

Attempts to process the image at the provided path, returning nil if either the images fails to process or is an unsupported format.

Source
from_io?(io : IO) : self | Nil

Attempts to process the image from the provided io, returning nil if either the images fails to process or is an unsupported format.

Source

Instance methods

bits

Returns the number of bits per pixel within this image, if available.

Source
channels

Returns the number of channels within this image, if available.

Source
format

Returns the format of this image.

Source
height

Returns the width of this image in pixels.

Source
size

Returns a tuple of this images size in the format of {width, height}.

Source
width

Returns the width of this image in pixels.

Source

Nested types