class Fluorite::SpriteSheet::DSL::SpriteSheetBuilder

• Fluorite::SpriteSheet::DSL::SpriteSheetBuilder
• Reference
• Object

Overview

Declarative builder for configuring and executing a SpriteSheet compression pipeline

Defined in:

fluorite/sprite_sheet/dsl/sprite_sheet_builder.cr

Constructors

• .new(config : Core::PipelineConfig = Core::PipelineConfig.new)

Instance Method Summary

• #animation(name : String, loop_anim : Bool = true) : self
• #background(color : String) : self
• #bayer_scale(scale : Int32) : self
• #clut4!(dither : Symbol | String | Core::DitherAlgorithm = Core::DitherAlgorithm::Sierra2_4a) : self
• #clut8!(dither : Symbol | String | Core::DitherAlgorithm = Core::DitherAlgorithm::Sierra2_4a) : self
• #columns(cols : Int32) : self
• #command : Fluorite::DSL::Command

  Builds the underlying Fluorite::DSL::Command

• #compression_level(level : Int32) : self
• #config : Core::PipelineConfig
• #crop(w : Int32, h : Int32, x : Int32 = 0, y : Int32 = 0) : self
• #dither(algo : Symbol | String | Core::DitherAlgorithm) : self
• #duration(time : String | Time::Span) : self
• #format(fmt : Symbol | String | Core::CompressionFormat) : self
• #fps(rate : Float64 | Int32) : self
• #frame_count(count : Int32) : self
• #frame_height(height : Int32) : self
• #frame_size(width : Int32, height : Int32) : self
• #frame_width(width : Int32) : self
• #frames(count : Int32) : self
• #godot_import(path : String) : self
• #godot_import!(enable : Bool = true) : self
• #grid(cols : Int32, r : Int32) : self
• #horizontal_strip! : self
• #input(path : String) : self
• #layout(policy : Symbol | String | Core::LayoutPolicy) : self
• #margin(px : Int32) : self
• #max_colors(colors : Int32) : self
• #metadata(path : String) : self
• #output(path : String) : self
• #padding(px : Int32) : self
• #pixel_art! : self
• #plan : Core::AtlasPlan

  Computes and returns the Core::AtlasPlan

• #power_of_two(enable : Bool = true) : self
• #power_of_two! : self
• #reserve_transparent(enable : Bool = true) : self
• #rgb565! : self
• #rgba32! : self
• #rows(r : Int32) : self
• #run(&progress_block : Runner::Progress -> Nil) : Tuple(Process::Status, Core::AtlasPlan)

  Runs the compression pipeline and writes any configured metadata sidecar files

• #run : Tuple(Process::Status, Core::AtlasPlan)
• #scale_flags(flags : Symbol | String | Core::ScaleFlags) : self
• #seek(time : String | Time::Span) : self
• #to(path : String) : self
• #to_cmd_string : String
• #vertical_strip! : self
• #webp!(quality : Int32 = 90, lossless : Bool = true) : self
• #write_sidecars!(atlas_plan : Core::AtlasPlan | Nil = nil) : Core::AtlasPlan

  Writes metadata JSON/YAML and Godot .import sidecar files if configured

Constructor Detail

Instance Method Detail