io7m | single-page | multi-page | Calino User Manual
1.2. check
Previous
1. Command-Line Interface
Up
1.4. create-array
Next

# 1.3. create-2d

- 1.3.1. Name
- 1.3.2. Description
- 1.3.3. Examples

## 1.3.1. Name

1
create-2d - Create 2D textures

## 1.3.2. Description

1
The create-2d command creates 2D texture files.

### 1.3.2.2. Parameters

Parameter | Type | Required | Description
--- | --- | --- | ---
--source | Path | true | The source image file
--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 an image file specified with --file 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.3.3. Examples

### 1.3.3.1. Example

    $ calino create-2d \
    --mipmap-generate BILINEAR \
    --output output.ctf \
    --super-compression LZ4 \
    --premultiply-alpha true \
    --metadata input.properties \
    --convert-layout-to "p16|R4:G4:B4:A4" \
    --source input.png

1.2. check
Previous
1. Command-Line Interface
Up
1.4. create-array
Next
io7m | single-page | multi-page | Calino User Manual