io7m | single-page | multi-page | epub | Calino User Manual
1.1. Overview
Previous
1. Command-Line Interface
Up
1.3. create-2d
Next

# 1.2. check

- 1.2.1. Name
- 1.2.2. Description
- 1.2.3. Examples

## 1.2.1. Name

1
check - Validate texture files

## 1.2.2. Description

1
The check command validates texture files.

### 1.2.2.2. Parameters

Parameter | Type | Required | Description
--- | --- | --- | ---
--file | Path | true | The texture file
--warnings-as-errors | boolean | false | Treat validation warnings as errors
--format-version | CLNVersion | false | The requested file format version
--verbose | CLPLogLevel | false | Set the minimum logging verbosity level.

3
The check command will read the texture file specified with --file and perform extensive validity testing against the properties given in the calino specification. Additionally, it will extract all image data into memory and check the data against any CRC32 checksums included in the texture file.
4
If the command encounteres no validation errors or warnings, it will not print anything.

## 1.2.3. Examples

### 1.2.3.1. Example

    $ calino check --file validation-cube-crc-mismatch.ctf
    calino: ERROR: validation-cube-crc-mismatch.ctf: @0x310: The mipmap description for layer 2, face X_NEGATIVE specifies a CRC32 value of 0x5edf2461 but the actual data had a CRC32 of 0x5edf2460.
    calino: ERROR:   See https://www.io7m.com/software/calino/specification/index.xhtml#id_09645697-fbde-43fe-9f34-48c851adb2ff for details.
    $ echo $?
    1

    $ calino check --file validation-cube-size-mismatch.ctf
    calino: ERROR: validation-cube-size-mismatch.ctf: @0x2f0: The mipmap description for layer 2, face X_POSITIVE specifies that the mipmap data should be 12 octets uncompressed, but the actual data was 13 octets.
    calino: ERROR:   See https://www.io7m.com/software/calino/specification/index.xhtml#id_e676eaef-f25a-44e8-9360-bcfaf35ce1e6 for details.
    calino: WARN: validation-cube-size-mismatch.ctf: @0xe0: For uncompressed image data, the compressed size 13 must equal the uncompressed size 12 (at level 2).
    calino: WARN:   See https://www.io7m.com/software/calino/specification/index.xhtml#id_579b15a3-09bb-4b14-87ab-0441ecc88b31 for details.
    $ echo $?
    1

    $ calino check --file array-mips.ctf
    $ echo $?
    0

1.1. Overview
Previous
1. Command-Line Interface
Up
1.3. create-2d
Next
io7m | single-page | multi-page | epub | Calino User Manual