core/image/png package | Odin Programming Language

Reader for `PNG` images. The PNG specification is at [[ https://www.w3.org/TR/PNG/ ]].

Collection Info

View Source

Collection: core
Path: image/png
Entries: 62

Constants 4

Jump to Constants

depth_scale_table INCHES_PER_METER MAX_CHUNK_SIZE MAX_IDAT_SIZE

Types 22

Jump to Types

cHRM cHRM_Raw CIE_1931 CIE_1931_Raw Error Filter_Params gAMA hIST iCCP Image Options pHYs pHYs_Unit PLTE PLTE_Entry Row_Filter +6 more

Procedures 31

Jump to Procedures

append_chunk chrm chunk_type_to_name copy_chunk core_time defilter defilter_16 defilter_8 defilter_less_than_8 destroy exif filter_paeth gamma hist iccp iccp_destroy +15 more

Procedure Groups 1

Jump to Procedure Groups

load

Variables 4

Jump to Variables

ADAM7_X_ORIG ADAM7_X_SPACING ADAM7_Y_ORIG ADAM7_Y_SPACING

Source Files

Constants

depth_scale_table #

Source

depth_scale_table :: []u8{0, 0xff, 0x55, 0, 0x11, 0, 0, 0, 0x01}

INCHES_PER_METER #

Source

INCHES_PER_METER :: 1000.0 / 25.4

MAX_CHUNK_SIZE #

Source

MAX_CHUNK_SIZE :: min(#config(PNG_MAX_CHUNK_SIZE, 16_777_216), 268_435_456)

For chunks other than IDAT with a variable size like `zTXT` and `eXIf`, limit their size to 16 MiB each by default. Max of 256 MiB each.

MAX_IDAT_SIZE #

Source

MAX_IDAT_SIZE :: min(#config(PNG_MAX_IDAT_SIZE, _MAX_IDAT_DEFAULT), _MAX_IDAT)

Types

cHRM #

Source

cHRM :: cHRM

cHRM_Raw #

Source

cHRM_Raw :: cHRM_Raw

CIE_1931 #

Source

CIE_1931 :: CIE_1931

CIE_1931_Raw #

Source

CIE_1931_Raw :: CIE_1931_Raw

Error #

Source

Error :: Error

Filter_Params #

Source

Filter_Params :: Filter_Params

gAMA #

Source

gAMA :: gAMA

hIST #

Source

hIST :: hIST

iCCP #

Source

iCCP :: iCCP

Image #

Source

Image :: Image

Options #

Source

Options :: Options

pHYs #

Source

pHYs :: pHYs

pHYs_Unit #

Source

pHYs_Unit :: pHYs_Unit

PLTE #

Source

PLTE :: PLTE

PLTE_Entry #

Source

PLTE_Entry :: [3]u8

Row_Filter #

Source

Row_Filter :: Row_Filter

Signature #

Source

Signature :: Signature

sPLT #

Source

sPLT :: sPLT

sRGB #

Source

sRGB :: sRGB

sRGB_Rendering_Intent #

Source

sRGB_Rendering_Intent :: sRGB_Rendering_Intent

Text #

Source

Text :: Text

tIME #

Source

tIME :: tIME

Other chunks

Procedures

append_chunk #

Source

append_chunk :: proc(list: ^[dynamic]PNG_Chunk, src: PNG_Chunk, allocator := context.allocator) -> (err: Error) {…}

chrm #

Source

chrm :: proc(c: PNG_Chunk) -> (res: cHRM, ok: bool) {…}

chunk_type_to_name #

Source

chunk_type_to_name :: proc(type: ^PNG_Chunk_Type) -> string {…}

copy_chunk #

Source

copy_chunk :: proc(src: PNG_Chunk, allocator := context.allocator) -> (dest: PNG_Chunk, err: Error) {…}

core_time #

Source

core_time :: proc(c: PNG_Chunk) -> (t: Time, ok: bool) {…}

defilter #

Source

defilter :: proc(img: ^Image, filter_bytes: ^Buffer, header: ^PNG_IHDR, options: Options) -> (err: Error) {…}

defilter_16 #

Source

defilter_16 :: proc(params: ^Filter_Params) -> bool {…}

defilter_8 #

Source

defilter_8 :: proc(params: ^Filter_Params) -> (ok: bool) {…}

defilter_less_than_8 #

Source

defilter_less_than_8 :: proc(params: ^Filter_Params) -> bool {…}

destroy #

Source

destroy :: proc(img: ^Image) {…}

exif #

Source

exif :: proc(c: PNG_Chunk) -> (res: Exif, ok: bool) {…}

filter_paeth #

Source

filter_paeth :: proc(left, up, up_left: u8) -> u8 {…}

gamma #

Source

gamma :: proc(c: PNG_Chunk) -> (res: f32, ok: bool) {…}

hist #

Source

hist :: proc(c: PNG_Chunk) -> (res: hIST, ok: bool) {…}

iccp #

Source

iccp :: proc(c: PNG_Chunk) -> (res: iCCP, ok: bool) {…}

iccp_destroy #

Source

iccp_destroy :: proc(i: iCCP) {…}

load_from_bytes #

Source

load_from_bytes :: proc(data: []u8, options: Options = Options{}, allocator := context.allocator) -> (img: ^Image, err: Error) {…}

load_from_context #

Source

load_from_context :: proc(ctx: ^$C, options: Options = Options{}, allocator := context.allocator) -> (img: ^Image, err: Error) {…}

load_from_file #

Source

load_from_file :: proc(filename: string, options: Options = Options{}, allocator := context.allocator) -> (img: ^Image, err: Error) {…}

phys #

Source

phys :: proc(c: PNG_Chunk) -> (res: pHYs, ok: bool) {…}

phys_to_dpi #

Source

phys_to_dpi :: proc(p: pHYs) -> (x_dpi, y_dpi: f32) {…}

plte #

Source

plte :: proc(c: PNG_Chunk) -> (res: PLTE, ok: bool) {…}

read_chunk #

Source

read_chunk :: proc(ctx: ^$C) -> (chunk: PNG_Chunk, err: Error) {…}

read_header #

Source

read_header :: proc(ctx: ^$C) -> (PNG_IHDR, Error) {…}

sbit #

Source

sbit :: proc(c: PNG_Chunk) -> (res: [4]u8, ok: bool) {…}

splt #

Source

splt :: proc(c: PNG_Chunk) -> (res: sPLT, ok: bool) {…}

splt_destroy #

Source

splt_destroy :: proc(s: sPLT) {…}

srgb #

Source

srgb :: proc(c: PNG_Chunk) -> (res: sRGB, ok: bool) {…}

text #

Source

text :: proc(c: PNG_Chunk) -> (res: Text, ok: bool) {…}

text_destroy #

Source

text_destroy :: proc(text: Text) {…}

time #

Source

time :: proc(c: PNG_Chunk) -> (res: tIME, ok: bool) {…}

Procedure Groups

load #

Source

load :: proc{
	load_from_file,
	load_from_bytes,
	load_from_context,
}

Variables

ADAM7_X_ORIG #

Source

ADAM7_X_ORIG: []int = []int{0, 4, 0, 2, 0, 1, 0}

ADAM7_X_SPACING #

Source

ADAM7_X_SPACING: []int = []int{8, 8, 4, 4, 2, 2, 1}

ADAM7_Y_ORIG #

Source

ADAM7_Y_ORIG: []int = []int{0, 0, 4, 0, 2, 0, 1}

ADAM7_Y_SPACING #

Source

ADAM7_Y_SPACING: []int = []int{8, 8, 8, 4, 4, 2, 2}