The 3b-hdr Reference Manual

Table of Contents

The 3b-hdr Reference Manual

This is the 3b-hdr Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 09:41:05 2020 GMT+0.

1 Introduction

Read/Write Radiance shared-exponent RGBE HDR image files

Reading

Read with (READ-HDR-FILE FILE-NAME &key FORMAT Y-UP) or (READ-HDR-STREAM STREAM &key FORMAT Y-UP).

FILE-NAME is a pathname designator for an HDR file.

STREAM is an open (unsigned-byte 8) input stream.

FORMAT is either :RGB9-E5(default) or :FLOAT. If it is :FLOAT, data will be returned as single-floats, if :RGB9-E5 it will be returned as (unsigned-byte 32) containing GL-style RGB9-E5 data.

Y-UP specifies that data should be returned as GL-style lower-left origin (bottom row first), otherwise it is returned with upper-left origin (top-row first).

Both functions return an HDR-FILE object with following accessors:

WIDTH = width of image in pixels

HEIGHT = height of image in rows

DATA = vector of (UNSIGNED-BYTE 32) with 1 element per pixel or SINGLE-FLOAT with 3 elements per pixel, depending on requested FORMAT when loading.

ORIGIN = :UPPER-LEFT or :LOWER-LEFT depending on requested Y-UP when loading.

GL-PIXEL-TYPE, GL-PIXEL-FORMAT, GL-INTERNAL-FORMAT = values suitable to pass to cl-opengl when creating/uploading textures from data, :unsigned-int-5-9-9-9-rev :rgb :rgb9-e5 or :float :rgb :rgb32f depending on FORMAT

EXPOSURE = (product of) EXPOSURE header value(s) in HDR file, or 1.0 if none specified. Usually 1.0.

Writing

Write with (WRITE-HDR-FILE FILE-NAME HDR &key UNCOMPRESSED IF-EXISTS IF-DOES-NOT-EXIST) or (WRITE-HDR-STREAM STREAM HDR &key UNCOMPRESSED)

FILE-NAME is a pathname designator for an HDR file to be written.

STREAM is an open (unsigned-byte 8) output stream.

HDR is an HDR-FILE object, with at least WIDTH, HEIGHT, DATA, GL-PIXEL-TYPE, and ORIGIN specified.

If UNCOMPRESSED is true, write scanlines as uncompressed RGBE instead of new-style RLE-compressed data.

IF-EXISTS (default :error) and IF-DOES-NOT-EXIST (default :create) are passed to CL:OPEN

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 3b-hdr

Author

Bart Botta <00003b at gmail.com>

License

MIT

Description

reader and writer for radiance HDR files

Dependencies

• alexandria
• babel
• parse-number
• split-sequence

Source

3b-hdr.asd (file)

Components

• package.lisp (file)
• hdr.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 3b-hdr.asd

Location

3b-hdr.asd

Systems

3b-hdr (system)

3.1.2 3b-hdr/package.lisp

Parent

3b-hdr (system)

Location

package.lisp

Packages

3b-hdr

3.1.3 3b-hdr/hdr.lisp

Dependency

package.lisp (file)

Parent

3b-hdr (system)

Location

hdr.lisp

Exported Definitions

• data (method)
• (setf data) (method)
• exposure (method)
• (setf exposure) (method)
• gl-internal-format (method)
• (setf gl-internal-format) (method)
• gl-pixel-format (method)
• (setf gl-pixel-format) (method)
• gl-pixel-type (method)
• (setf gl-pixel-type) (method)
• hdr-file (class)
• headers (method)
• (setf headers) (method)
• height (method)
• (setf height) (method)
• origin (method)
• (setf origin) (method)
• read-hdr-file (function)
• read-hdr-stream (function)
• width (method)
• (setf width) (method)
• write-hdr-file (function)
• write-hdr-stream (function)

Internal Definitions

• *c* (special variable)
• *r* (special variable)
• *row* (special variable)
• buf (class)
• buf-buf (method)
• (setf buf-buf) (method)
• buf-empty (function)
• buf-end (method)
• (setf buf-end) (method)
• buf-eof (function)
• buf-peek-byte (function)
• buf-pos (method)
• (setf buf-pos) (method)
• buf-read-byte (function)
• buf-read-line (function)
• buf-stream (method)
• ilambda (macro)
• new-rle-count (function)
• new-rle-p (function)
• old-rle-p (function)
• read-hdr-header (function)
• read-scanline (function)
• read-scanline-new (function)
• read-scanline-old (function)
• read-scanline-old/float (function)
• read-scanline-old/rgb9e5 (function)
• refill-buf (function)
• rgb2rgbe (function)
• rgb9e5tofloat (function)
• with-line-readers (macro)
• write-scanline (function)
• write-scanline/new (function)
• write-scanline/old (function)

4 Packages

Packages are listed by definition order.

4.1 3b-hdr

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• data (generic function)
• data (method)
• (setf data) (method)
• (setf data) (generic function)
• exposure (generic function)
• exposure (method)
• (setf exposure) (method)
• (setf exposure) (generic function)
• gl-internal-format (generic function)
• gl-internal-format (method)
• (setf gl-internal-format) (method)
• (setf gl-internal-format) (generic function)
• gl-pixel-format (generic function)
• gl-pixel-format (method)
• (setf gl-pixel-format) (method)
• (setf gl-pixel-format) (generic function)
• gl-pixel-type (generic function)
• gl-pixel-type (method)
• (setf gl-pixel-type) (method)
• (setf gl-pixel-type) (generic function)
• hdr-file (class)
• headers (generic function)
• headers (method)
• (setf headers) (method)
• (setf headers) (generic function)
• height (generic function)
• height (method)
• (setf height) (method)
• (setf height) (generic function)
• origin (generic function)
• origin (method)
• (setf origin) (method)
• (setf origin) (generic function)
• read-hdr-file (function)
• read-hdr-stream (function)
• width (generic function)
• width (method)
• (setf width) (method)
• (setf width) (generic function)
• write-hdr-file (function)
• write-hdr-stream (function)

Internal Definitions

• *c* (special variable)
• *r* (special variable)
• *row* (special variable)
• buf (class)
• buf-buf (generic function)
• buf-buf (method)
• (setf buf-buf) (method)
• (setf buf-buf) (generic function)
• buf-empty (function)
• buf-end (generic function)
• buf-end (method)
• (setf buf-end) (method)
• (setf buf-end) (generic function)
• buf-eof (function)
• buf-peek-byte (function)
• buf-pos (generic function)
• buf-pos (method)
• (setf buf-pos) (method)
• (setf buf-pos) (generic function)
• buf-read-byte (function)
• buf-read-line (function)
• buf-stream (generic function)
• buf-stream (method)
• ilambda (macro)
• new-rle-count (function)
• new-rle-p (function)
• old-rle-p (function)
• read-hdr-header (function)
• read-scanline (function)
• read-scanline-new (function)
• read-scanline-old (function)
• read-scanline-old/float (function)
• read-scanline-old/rgb9e5 (function)
• refill-buf (function)
• rgb2rgbe (function)
• rgb9e5tofloat (function)
• with-line-readers (macro)
• write-scanline (function)
• write-scanline/new (function)
• write-scanline/old (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: read-hdr-file FILE &key FORMAT Y-UP

Reads a radiance HDR image from FILE into a vector
of (UNSIGNED-BYTE 32) if FORMAT is :RGB9-E5, or SINGLE-FLOAT if format is :FLOAT. If Y-UP is true, data is stored with bottom row of image first, otherwise top row first.

Package

3b-hdr

Source

hdr.lisp (file)

Function: read-hdr-stream STREAM &key FORMAT Y-UP

Reads a radiance HDR image from STREAM into a vector
of (UNSIGNED-BYTE 32) if FORMAT is :RGB9-E5, or SINGLE-FLOAT if format is :FLOAT. If Y-UP is true, data is stored with bottom row of image first, otherwise top row first.

Package

3b-hdr

Source

hdr.lisp (file)

Function: write-hdr-file FILE HDR &key UNCOMPRESSED IF-EXISTS IF-DOES-NOT-EXIST

Write HDR to FILE, with ’new rle’ compression unless UNCOMPRESSED is true. HDR must have at least WIDTH, HEIGHT, GL-PIXEL-TYPE and DATA values specified. If GL-PIXEL-TYPE is :FLOAT, DATA should be a vector of R,G,B values. Otherwise, DATA is assumed to be a vector of RGB9-E5 values.

Package

3b-hdr

Source

hdr.lisp (file)

Function: write-hdr-stream STREAM HDR &key UNCOMPRESSED

Write HDR to (UNSIGNED-BYTE 8) output stream STREAM, with ’new rle’ compression unless UNCOMPRESSED is true. HDR must have at least WIDTH, HEIGHT, GL-PIXEL-TYPE and DATA values specified. If GL-PIXEL-TYPE is :FLOAT, DATA should be a vector of R,G,B values. Otherwise, DATA is assumed to be a vector of RGB9-E5 values.

Package

3b-hdr

Source

hdr.lisp (file)

5.1.2 Generic functions

Generic Function: data OBJECT

Generic Function: (setf data) NEW-VALUE OBJECT

Package

3b-hdr

Methods

Method: data (HDR-FILE hdr-file)

automatically generated reader method

Source

hdr.lisp (file)

Method: (setf data) NEW-VALUE (HDR-FILE hdr-file)

automatically generated writer method

Source

hdr.lisp (file)

Generic Function: exposure OBJECT

Generic Function: (setf exposure) NEW-VALUE OBJECT

Package

3b-hdr

Methods

Method: exposure (HDR-FILE hdr-file)

automatically generated reader method

Source

hdr.lisp (file)

Method: (setf exposure) NEW-VALUE (HDR-FILE hdr-file)

automatically generated writer method

Source

hdr.lisp (file)

Generic Function: gl-internal-format OBJECT

Generic Function: (setf gl-internal-format) NEW-VALUE OBJECT

Package

3b-hdr

Methods

Method: gl-internal-format (HDR-FILE hdr-file)

automatically generated reader method

Source

hdr.lisp (file)

Method: (setf gl-internal-format) NEW-VALUE (HDR-FILE hdr-file)

automatically generated writer method

Source

hdr.lisp (file)

Generic Function: gl-pixel-format OBJECT

Generic Function: (setf gl-pixel-format) NEW-VALUE OBJECT

Package

3b-hdr

Methods

Method: gl-pixel-format (HDR-FILE hdr-file)

automatically generated reader method

Source

hdr.lisp (file)

Method: (setf gl-pixel-format) NEW-VALUE (HDR-FILE hdr-file)

automatically generated writer method

Source

hdr.lisp (file)

Generic Function: gl-pixel-type OBJECT

Generic Function: (setf gl-pixel-type) NEW-VALUE OBJECT

Package

3b-hdr

Methods

Method: gl-pixel-type (HDR-FILE hdr-file)

automatically generated reader method

Source

hdr.lisp (file)

Method: (setf gl-pixel-type) NEW-VALUE (HDR-FILE hdr-file)

automatically generated writer method

Source

hdr.lisp (file)

Generic Function: headers OBJECT

Generic Function: (setf headers) NEW-VALUE OBJECT

Package

3b-hdr

Methods

Method: headers (HDR-FILE hdr-file)

automatically generated reader method

Source

hdr.lisp (file)

Method: (setf headers) NEW-VALUE (HDR-FILE hdr-file)

automatically generated writer method

Source

hdr.lisp (file)

Generic Function: height OBJECT

Generic Function: (setf height) NEW-VALUE OBJECT

Package

3b-hdr

Methods

Method: height (HDR-FILE hdr-file)

automatically generated reader method

Source

hdr.lisp (file)

Method: (setf height) NEW-VALUE (HDR-FILE hdr-file)

automatically generated writer method

Source

hdr.lisp (file)

Generic Function: origin OBJECT

Generic Function: (setf origin) NEW-VALUE OBJECT

Package

3b-hdr

Methods

Method: origin (HDR-FILE hdr-file)

automatically generated reader method

Source

hdr.lisp (file)

Method: (setf origin) NEW-VALUE (HDR-FILE hdr-file)

automatically generated writer method

Source

hdr.lisp (file)

Generic Function: width OBJECT

Generic Function: (setf width) NEW-VALUE OBJECT

Package

3b-hdr

Methods

Method: width (HDR-FILE hdr-file)

automatically generated reader method

Source

hdr.lisp (file)

Method: (setf width) NEW-VALUE (HDR-FILE hdr-file)

automatically generated writer method

Source

hdr.lisp (file)

5.1.3 Classes

Class: hdr-file ()

Package

3b-hdr

Source

hdr.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• exposure (method)
• exposure (method)
• gl-internal-format (method)
• gl-internal-format (method)
• gl-pixel-format (method)
• gl-pixel-format (method)
• gl-pixel-type (method)
• gl-pixel-type (method)
• origin (method)
• origin (method)
• data (method)
• data (method)
• headers (method)
• headers (method)
• height (method)
• height (method)
• width (method)
• width (method)

Direct slots

Slot: width

Initargs

:width

Readers

width (generic function)

Writers

(setf width) (generic function)

Slot: height

Initargs

:height

Readers

height (generic function)

Writers

(setf height) (generic function)

Slot: headers

Initargs

:headers

Readers

headers (generic function)

Writers

(setf headers) (generic function)

Slot: data

Initargs

:data

Readers

data (generic function)

Writers

(setf data) (generic function)

Slot: origin

Initargs

:origin

Initform

:upper-left

Readers

origin (generic function)

Writers

(setf origin) (generic function)

Slot: gl-pixel-type

Initargs

:pixel-type

Readers

gl-pixel-type (generic function)

Writers

(setf gl-pixel-type) (generic function)

Slot: gl-pixel-format

Initargs

:pixel-format

Readers

gl-pixel-format (generic function)

Writers

(setf gl-pixel-format) (generic function)

Slot: gl-internal-format

Initargs

:internal-format

Readers

gl-internal-format (generic function)

Writers

(setf gl-internal-format) (generic function)

Slot: exposure

Initargs

:exposure

Readers

exposure (generic function)

Writers

(setf exposure) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *c*

Package

3b-hdr

Source

hdr.lisp (file)

Special Variable: *r*

Package

3b-hdr

Source

hdr.lisp (file)

Special Variable: *row*

Package

3b-hdr

Source

hdr.lisp (file)

5.2.2 Macros

Macro: ilambda ARGS &body BODY

Package

3b-hdr

Source

hdr.lisp (file)

Macro: with-line-readers (%BUF) &body BODY

Package

3b-hdr

Source

hdr.lisp (file)

5.2.3 Functions

Function: buf-empty BUF

Package

3b-hdr

Source

hdr.lisp (file)

Function: buf-eof BUF

Package

3b-hdr

Source

hdr.lisp (file)

Function: buf-peek-byte BUF

Package

3b-hdr

Source

hdr.lisp (file)

Function: buf-read-byte BUF

Package

3b-hdr

Source

hdr.lisp (file)

Function: buf-read-line BUF

Package

3b-hdr

Source

hdr.lisp (file)

Function: new-rle-count R G B E

Package

3b-hdr

Source

hdr.lisp (file)

Function: new-rle-p R G B E

Package

3b-hdr

Source

hdr.lisp (file)

Function: old-rle-p R G B E

Package

3b-hdr

Source

hdr.lisp (file)

Function: read-hdr-header BUF

Package

3b-hdr

Source

hdr.lisp (file)

Function: read-scanline %BUF LENGTH DESTINATION &key OFFSET TYPE

Package

3b-hdr

Source

hdr.lisp (file)

Function: read-scanline-new %BUF R G B E LENGTH DESTINATION OFFSET TYPE

Package

3b-hdr

Source

hdr.lisp (file)

Function: read-scanline-old %BUF R G B E LENGTH DESTINATION OFFSET TYPE

Package

3b-hdr

Source

hdr.lisp (file)

Function: read-scanline-old/float %BUF R G B E LENGTH DESTINATION OFFSET

Package

3b-hdr

Source

hdr.lisp (file)

Function: read-scanline-old/rgb9e5 %BUF R G B E LENGTH DESTINATION OFFSET

Package

3b-hdr

Source

hdr.lisp (file)

Function: refill-buf BUF

Package

3b-hdr

Source

hdr.lisp (file)

Function: rgb2rgbe R G B

Package

3b-hdr

Source

hdr.lisp (file)

Function: rgb9e5tofloat A

Package

3b-hdr

Source

hdr.lisp (file)

Function: write-scanline STREAM DATA WIDTH OFFSET COMPRESS

Package

3b-hdr

Source

hdr.lisp (file)

Function: write-scanline/new STREAM DATA WIDTH OFFSET

Package

3b-hdr

Source

hdr.lisp (file)

Function: write-scanline/old STREAM DATA WIDTH OFFSET COMPRESS

Package

3b-hdr

Source

hdr.lisp (file)

5.2.4 Generic functions

Generic Function: buf-buf OBJECT

Generic Function: (setf buf-buf) NEW-VALUE OBJECT

Package

3b-hdr

Methods

Method: buf-buf (BUF buf)

automatically generated reader method

Source

hdr.lisp (file)

Method: (setf buf-buf) NEW-VALUE (BUF buf)

automatically generated writer method

Source

hdr.lisp (file)

Generic Function: buf-end OBJECT

Generic Function: (setf buf-end) NEW-VALUE OBJECT

Package

3b-hdr

Methods

Method: buf-end (BUF buf)

automatically generated reader method

Source

hdr.lisp (file)

Method: (setf buf-end) NEW-VALUE (BUF buf)

automatically generated writer method

Source

hdr.lisp (file)

Generic Function: buf-pos OBJECT

Generic Function: (setf buf-pos) NEW-VALUE OBJECT

Package

3b-hdr

Methods

Method: buf-pos (BUF buf)

automatically generated reader method

Source

hdr.lisp (file)

Method: (setf buf-pos) NEW-VALUE (BUF buf)

automatically generated writer method

Source

hdr.lisp (file)

Generic Function: buf-stream OBJECT

Package

3b-hdr

Methods

Method: buf-stream (BUF buf)

automatically generated reader method

Source

hdr.lisp (file)

5.2.5 Classes

Class: buf ()

Package

3b-hdr

Source

hdr.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• buf-buf (method)
• buf-buf (method)
• buf-end (method)
• buf-end (method)
• buf-pos (method)
• buf-pos (method)
• buf-stream (method)

Direct slots

Slot: stream

Initargs

:stream

Readers

buf-stream (generic function)

Slot: pos

Initform

0

Readers

buf-pos (generic function)

Writers

(setf buf-pos) (generic function)

Slot: end

Initform

0

Readers

buf-end (generic function)

Writers

(setf buf-end) (generic function)

Slot: buf

Initform

(make-array 8192 :element-type (quote (unsigned-byte 8)) :initial-element 0)

Readers

buf-buf (generic function)

Writers

(setf buf-buf) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types