struct Athena::ImageSize::Image

Overview

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)

Defined in:

image.cr
image_format.cr

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.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.


[View source]
def self.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.


[View source]

Class Method Detail

def self.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.


[View source]
def self.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.


[View source]

Instance Method Detail

def bits : Int32 | Nil #

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


[View source]
def channels : Int32 | Nil #

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


[View source]

Returns the format of this image.


[View source]
def height : Int32 #

Returns the width of this image in pixels.


[View source]
def size : Tuple(Int32, Int32) #

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


[View source]
def width : Int32 #

Returns the width of this image in pixels.


[View source]