NVTX C++ API Reference 1.0
C++ convenience wrappers for NVTX v3 C API
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
nvtx3::v1::rgb Struct Reference

Indicates the values of the red, green, and blue color channels for an RGB color to use as an event attribute (assumes no transparency). More...

#include <nvtx3.hpp>

Inheritance diagram for nvtx3::v1::rgb:
Inheritance graph
[legend]

Public Types

using component_type = uint8_t
 Type used for component values. More...
 

Public Member Functions

constexpr rgb (component_type red_, component_type green_, component_type blue_) noexcept
 Construct a rgb with red, green, and blue channels specified by red_, green_, and blue_, respectively. More...
 

Public Attributes

component_type red {}
 Red channel value. More...
 
component_type green {}
 Green channel value. More...
 
component_type blue {}
 Blue channel value. More...
 

Detailed Description

Indicates the values of the red, green, and blue color channels for an RGB color to use as an event attribute (assumes no transparency).

Definition at line 952 of file nvtx3.hpp.

Member Typedef Documentation

◆ component_type

Type used for component values.

Definition at line 954 of file nvtx3.hpp.

Constructor & Destructor Documentation

◆ rgb()

constexpr nvtx3::v1::rgb::rgb ( component_type  red_,
component_type  green_,
component_type  blue_ 
)
inlineconstexprnoexcept

Construct a rgb with red, green, and blue channels specified by red_, green_, and blue_, respectively.

Valid values are in the range [0,255].

Parameters
red_Value of the red channel
green_Value of the green channel
blue_Value of the blue channel

Definition at line 966 of file nvtx3.hpp.

Member Data Documentation

◆ blue

component_type nvtx3::v1::rgb::blue {}

Blue channel value.

Definition at line 976 of file nvtx3.hpp.

◆ green

component_type nvtx3::v1::rgb::green {}

Green channel value.

Definition at line 975 of file nvtx3.hpp.

◆ red

component_type nvtx3::v1::rgb::red {}

Red channel value.

Definition at line 974 of file nvtx3.hpp.


The documentation for this struct was generated from the following file: