Skip to content

Commit

Permalink
[usdImagingGL] Improve documentation for color correction API
Browse files Browse the repository at this point in the history
See PixarAnimationStudios#1491

(Internal change: 2194152)
  • Loading branch information
rajabala authored and lkerley committed Jan 7, 2022
1 parent 004b0d5 commit 7083a3f
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion pxr/usdImaging/usdImagingGL/engine.h
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,20 @@ class UsdImagingGLEngine
/// @{
// ---------------------------------------------------------------------

/// Set \p id to one of the HdxColorCorrectionTokens.
/// Set \p ccType to one of the HdxColorCorrectionTokens:
/// {disabled, sRGB, openColorIO}
///
/// If 'openColorIO' is used, \p ocioDisplay, \p ocioView, \p ocioColorSpace
/// and \p ocioLook are options the client may supply to configure OCIO.
/// \p ocioColorSpace refers to the input (source) color space.
/// The default value is substituted if an option isn't specified.
/// You can find the values for these strings inside the
/// profile/config .ocio file. For example:
///
/// displays:
/// rec709g22:
/// !<View> {name: studio, colorspace: linear, looks: studio_65_lg2}
///
USDIMAGINGGL_API
void SetColorCorrectionSettings(
TfToken const& ccType,
Expand Down

0 comments on commit 7083a3f

Please sign in to comment.