cuda-api-wrappers
Thin C++-flavored wrappers for the CUDA Runtime API
cuda::profiling::color_t Struct Reference

An RGB colorspace color value, with potential transparency, which may be used to color elements in timelines or other graphical displays of profiling information. More...

#include <profiling.hpp>

Public Types

using underlying_type = ::std::uint32_t
 A profiler color corresponds to a 32-bit value.
 
using channel_value = ::std::uint8_t
 Each color channel is an 8-bit value.
 

Public Member Functions

underlying_type as_hex () const noexcept
 
 operator underlying_type () const noexcept
 

Static Public Member Functions

static constexpr color_t from_hex (underlying_type raw_argb) noexcept
 Construct a profiler color value from a numeric value (typically, an 8-hex-digit literal)
 
static constexpr color_t Black () noexcept
 Some basic colors, for convenience.
 
static constexpr color_t White () noexcept
 
static constexpr color_t FullRed () noexcept
 
static constexpr color_t FullGreen () noexcept
 
static constexpr color_t FullBlue () noexcept
 
static constexpr color_t FullYellow () noexcept
 
static constexpr color_t LightRed () noexcept
 
static constexpr color_t LightGreen () noexcept
 
static constexpr color_t LightBlue () noexcept
 
static constexpr color_t LightYellow () noexcept
 
static constexpr color_t DarkRed () noexcept
 
static constexpr color_t DarkGreen () noexcept
 
static constexpr color_t DarkBlue () noexcept
 
static constexpr color_t DarkYellow () noexcept
 

Public Attributes

channel_value alpha
 A profiler color is made up of three color channels and a transparency or "alpha" channel.
 
channel_value red
 
channel_value green
 
channel_value blue
 

Detailed Description

An RGB colorspace color value, with potential transparency, which may be used to color elements in timelines or other graphical displays of profiling information.

Member Function Documentation

◆ as_hex()

underlying_type cuda::profiling::color_t::as_hex ( ) const
inlinenoexcept
Returns
the numeric value corresponding to this profiler color

◆ operator underlying_type()

cuda::profiling::color_t::operator underlying_type ( ) const
inlinenoexcept

Returns
the numeric value corresponding to this profiler color

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