AcademySoftwareFoundation / AcademySoftwareFoundation/openexr

Describe new compression method API in documentation

Open
#1,859 2 comments 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
C
Stars
1.8k
Forks
700
Avg merge
3d 12h
Merged PRs (30d)
29

Description

Add to https://openexr.com/en/latest/ReadingAndWritingImageFiles.html#compression, source is [here](https://github.com/AcademySoftwareFoundation/openexr/blob/main/website/ReadingAndWritingImageFiles.rst#compression).

In anticipation of future support for new compression types, there is now a convenience API for mapping between compression type names and the associated enum:

```
getCompressionDescriptionFromId(Compression, std::string&)
getCompressionIdFromName(const std::string&, Compression&)
getCompressionNameFromId(Compression, std::string&)
getCompressionNamesString(const std::string&, std::string&)
getCompressionNumScanlines(Compression)
isValidCompression(int)
```

Contributor guide

Open the contributing guide

Research direction

Open website/ReadingAndWritingImageFiles.rst and locate the compression section linked by the issue. Compare it with the listed compression convenience API functions and document their purpose and signatures there. Done means the rendered Reading and Writing Image Files compression section describes all six functions.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.