io7m | single-page | multi-page | epub | Calino User Manual
1.4. create-array
Previous
1. Command-Line Interface
Up
1.6. extract-image-data-2d
Next

# 1.5. create-cube

- 1.5.1. Name
- 1.5.2. Description
- 1.5.3. Examples

## 1.5.1. Name

1
create-cube - Create cube textures

## 1.5.2. Description

1
The create-cube command creates cube texture files.

### 1.5.2.2. Parameters

Parameter | Type | Required | Description
--- | --- | --- | ---
--source-x-positive | Path | true | The source image file for the positive X face
--source-x-negative | Path | true | The source image file for the negative X face
--source-y-positive | Path | true | The source image file for the positive Y face
--source-y-negative | Path | true | The source image file for the negative Y face
--source-z-positive | Path | true | The source image file for the positive Z face
--source-z-negative | Path | true | The source image file for the negative Z face
--output | Path | true | The output texture file
--mipmap-generate | CLNImageMipMapFilter | false | The mipmap filter
--premultiply-alpha | boolean | false | Premultiply alpha
--byte-order | CLNByteOrder | false | The byte order used for image data
--format-version | CLNVersion | false | The requested file format version
--convert-layout-to | CLNChannelsLayoutDescriptionType | false | The requested layout to which to convert
--super-compression | CLNSuperCompressionMethodType | false | The super compression method.
--metadata | Path | false | A Java properties file containing metadata for the texture file.
--verbose | CLPLogLevel | false | Set the minimum logging verbosity level.

3
The command takes a set of image files specified with --source-x-negative, --source-x-positive, --source-y-negative, --source-y-positive, --source-z-negative, and --source-z-positive, and writes a texture file to --output.
4
If the --mipmap-generate parameter is specified with a value of one of the named filters [BICUBIC, BILINEAR, NEAREST] then a series of mipmaps will be generated in the texture file with each scaled-down mip level being processed with the given filter.
5
If the --byte-order parameter is specified with a value of one of the named endianness values [BIG_ENDIAN, LITTLE_ENDIAN]. The endianness value determines how image data will be stored and is primarily useful for applications that wish to memory-map texture files for direct uploading to GPUs.
6
The --convert-layout-to parameter specifies that the image data provided by the input file should be converted to the given channel layout.
7
The --metadata parameter specifies a file containing key/value metadata in Java properties format. The metadata keys and values will be inserted into the generated texture file.
8
If the --premultiply-alpha parameter is specified, then the data in the input file will be alpha-premultiplied when written to the output texture file.
9
If the --super-compression parameter is specified, then the image data in the output file will be compressed using the given compression method. Currently, the only supported supercompression method is LZ4.

## 1.5.3. Examples

### 1.5.3.1. Example

    $ calino create-cube \
    --mipmap-generate BILINEAR \
    --output output.ctf \
    --super-compression LZ4 \
    --metadata input.properties \
    --convert-layout-to "p16|R5:G6:B5" \
    --source-x-negative x-n-input.png \
    --source-x-positive x-p-input.png \
    --source-y-negative y-n-input.png \
    --source-y-positive y-p-input.png \
    --source-z-negative z-n-input.png \
    --source-z-positive z-p-input.png

1.4. create-array
Previous
1. Command-Line Interface
Up
1.6. extract-image-data-2d
Next
io7m | single-page | multi-page | epub | Calino User Manual