AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

Add code examples for ColorSpaceMenuHelper

Aperta
#1,869 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Documentation good first issue help wanted
Lingua principale
C++
Stelle
2.1k
Fork
503
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

The [documentation provides some C++ and Python code examples](https://opencolorio.readthedocs.io/en/latest/guides/developing/developing.html) for doing various things with the OCIO API. There is a need for some examples that shows how to use the AppHelpers API which is intended to help app developers improve their user experience. The most important thing to add would be how to use the [ColorSpaceMenuHelper API ](https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/87126fad7f27a703850e098a9a75e0ef206b3da9/include/OpenColorIO/OpenColorAppHelpers.h#L190)which is intended to allow applications to easily build color space menus that are filtered using attributes such as categories.

This should show how to configure the ColorSpaceMenuParameters, instantiate a ColorSpaceMenuHelper, and iterate over the resulting menu items.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia con la guida allo sviluppo collegata nell’issue e ispeziona OpenColorAppHelpers.h intorno a ColorSpaceMenuHelper e ColorSpaceMenuParameters. Aggiungi un esempio che mostri la configurazione dei parametri, la creazione dell’helper e l’iterazione sugli elementi del menu; la documentazione è completa quando uno sviluppatore di app può seguirla per creare un menu degli spazi colore filtrato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
cpp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.