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

Indicates the value of the alpha, red, green, and blue color channels for an ARGB color to use as an event attribute. More...

#include <nvtx3.hpp>

Inheritance diagram for nvtx3::v1::argb:
Inheritance graph
[legend]
Collaboration diagram for nvtx3::v1::argb:
Collaboration graph
[legend]

Public Member Functions

constexpr argb (component_type alpha_, component_type red_, component_type green_, component_type blue_) noexcept
 Construct an argb with alpha, red, green, and blue channels specified by alpha_, red_, green_, and blue_, respectively.
 
- Public Member Functions inherited from nvtx3::v1::rgb
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.
 

Public Attributes

component_type alpha {}
 Alpha channel value.
 
- Public Attributes inherited from nvtx3::v1::rgb
component_type red {}
 Red channel value.
 
component_type green {}
 Green channel value.
 
component_type blue {}
 Blue channel value.
 

Additional Inherited Members

- Public Types inherited from nvtx3::v1::rgb
using component_type = uint8_t
 Type used for component values.
 

Detailed Description

Indicates the value of the alpha, red, green, and blue color channels for an ARGB color to use as an event attribute.

Definition at line 1012 of file nvtx3.hpp.

Constructor & Destructor Documentation

◆ argb()

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

Construct an argb with alpha, red, green, and blue channels specified by alpha_, red_, green_, and blue_, respectively.

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

Parameters
alpha_Value of the alpha channel (opacity)
red_Value of the red channel
green_Value of the green channel
blue_Value of the blue channel

Definition at line 1025 of file nvtx3.hpp.

Member Data Documentation

◆ alpha

component_type nvtx3::v1::argb::alpha {}

Alpha channel value.

Definition at line 1034 of file nvtx3.hpp.


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