Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe new compression method API in documentation #1859

Open
cary-ilm opened this issue Oct 2, 2024 · 2 comments
Open

Describe new compression method API in documentation #1859

cary-ilm opened this issue Oct 2, 2024 · 2 comments

Comments

@cary-ilm
Copy link
Member

cary-ilm commented Oct 2, 2024

Add to https://openexr.com/en/latest/ReadingAndWritingImageFiles.html#compression, source is here.

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)
@SaxenaAnushka102
Copy link

Hello @cary-ilm! I'd like to take this up. The source link is showing "Not found". Could you please help with the active link? Thanks!

@cary-ilm
Copy link
Member Author

cary-ilm commented Oct 5, 2024

@SaxenaAnushka102, thanks! The link to the source is fixed now. Hopefully reading the source code and comment will explain what each function does.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants