OpenImageIO icon indicating copy to clipboard operation
OpenImageIO copied to clipboard

imagebuf docs examples: c++ examples, outfile, run script, and doc (#3992)

Open MichaelRCarroll-Intel opened this issue 2 years ago • 4 comments
trafficstars

Description

This PR address the docs files with accompanying examples #3992. The initial commit has c++ only to check if the PR is on the right track. Python can be added next.

  • Unfortunately, I still can't get the ctest test bed to run automagically. So I'm blocked on checking the full suite of SHAs and text output via ref/out.txt.
  • I was able to run the docs-examples-imagebuf.cpp as a one off and get sensible results.
  • The original inline example source needed minor fixes to a couple of breaks. It would be time consuming for newbies to resolve, so the example source changes are sorely needed.

As of time of submission my company is still getting the CLA together. Expectation is this PR will help for review but be blocked from merge until CLA is resolved. Reference the #devdays slack channel 11:47a california time 20231013 Sean McDuffe thread.

Sidebar: A linux foundation appropriately put a contribution on this PR into pending. This PR is from a colleague at my company.

Thanks.

Tests

Testing was performed on Ubuntu 22.04 w/ GNU 11.4 system compiler. Result image info and SHAs were generated with oiiotool from a build from yesterday's master branch.

Checklist:

  • [x] I have read the contribution guidelines.
  • [x] I have updated the documentation, if applicable.
  • [ ] I have ensured that the change is tested somewhere in the testsuite (adding new test cases if necessary).
  • [ ] If I added or modified a C++ API call, I have also amended the corresponding Python bindings (and if altering ImageBufAlgo functions, also exposed the new functionality as oiiotool options).
  • [x] My code follows the prevailing code style of this project. If I haven't already run clang-format before submitting, I definitely will look at the CI test that runs clang-format and fix anything that it highlights as being nonconforming.

MichaelRCarroll-Intel avatar Oct 13 '23 22:10 MichaelRCarroll-Intel

CLA Not Signed

Forgot to sign with -s, so I amended previous commit and force pushed.

MichaelRCarroll-Intel avatar Oct 13 '23 23:10 MichaelRCarroll-Intel

I believe that the CI failures are all because docs-examples-cpp/ref/out.txt needs to be updated.

lgritz avatar Oct 14 '23 00:10 lgritz

I'm going to tackle the make texture example in the imagebufalgo doc.

grdanny avatar Oct 15 '23 22:10 grdanny