lib/chunky_png/image.rb in chunky_png-1.3.11 vs lib/chunky_png/image.rb in chunky_png-1.3.12
- old
+ new
@@ -1,39 +1,37 @@
module ChunkyPNG
-
# ChunkyPNG::Image is an extension of the {ChunkyPNG::Canvas} class, that
# also includes support for metadata.
#
# @see ChunkyPNG::Canvas
class Image < Canvas
-
# The minimum size of bytes the value of a metadata field should be before compression
# is enabled for the chunk.
METADATA_COMPRESSION_TRESHOLD = 300
-
+
# @return [Hash] The hash of metadata fields for this PNG image.
attr_accessor :metadata
-
+
# Initializes a new ChunkyPNG::Image instance.
# @param [Integer] width The width of the new image.
# @param [Integer] height The height of the new image.
# @param [Integer] bg_color The background color of the new image.
# @param [Hash] metadata A hash of metadata fields and values for this image.
# @see ChunkyPNG::Canvas#initialize
def initialize(width, height, bg_color = ChunkyPNG::Color::TRANSPARENT, metadata = {})
super(width, height, bg_color)
@metadata = metadata
end
-
+
# Initializes a copy of another ChunkyPNG::Image instance.
#
# @param [ChunkyPNG::Image] other The other image to copy.
def initialize_copy(other)
super(other)
@metadata = other.metadata
end
-
+
# Returns the metadata for this image as PNG chunks.
#
# Chunks will either be of the {ChunkyPNG::Chunk::Text} type for small
# values (in bytes), or of the {ChunkyPNG::Chunk::CompressedText} type
# for values that are larger in size.
@@ -47,11 +45,11 @@
else
ChunkyPNG::Chunk::Text.new(key, value)
end
end
end
-
+
# Encodes the image to a PNG datastream for saving to disk or writing to an IO stream.
#
# Besides encoding the canvas, it will also encode the metadata fields to text chunks.
#
# @param [Hash] constraints The constraints to use when encoding the canvas.
@@ -59,21 +57,21 @@
# @see ChunkyPNG::Canvas::PNGEncoding#to_datastream
# @see #metadata_chunks
def to_datastream(constraints = {})
ds = super(constraints)
ds.other_chunks += metadata_chunks
- return ds
+ ds
end
-
+
# Reads a ChunkyPNG::Image instance from a data stream.
#
# Besides decoding the canvas, this will also read the metadata fields
# from the datastream.
#
- # @param [ChunkyPNG::Datastream] The datastream to read from.
+ # @param [ChunkyPNG::Datastream] ds The datastream to read from.
def self.from_datastream(ds)
image = super(ds)
image.metadata = ds.metadata
- return image
+ image
end
end
end