impeller::compiler::StructMember Struct Reference

#include <reflector.h>

Public Types
enum class	UnderlyingType {   kPadding ,   kFloat ,   kOther }

Public Member Functions
	StructMember (std::string p_type, spirv_cross::SPIRType::BaseType p_base_type, std::string p_name, size_t p_offset, size_t p_size, size_t p_byte_length, std::optional< size_t > p_array_elements, size_t p_element_padding, std::optional< std::string > p_float_type=std::nullopt, size_t p_vec_size=0u, size_t p_columns=0u, UnderlyingType p_underlying_type=UnderlyingType::kOther)
	Constructs a new StructMember.

Static Public Member Functions
static std::string	BaseTypeToString (spirv_cross::SPIRType::BaseType type)
static UnderlyingType	DetermineUnderlyingType (spirv_cross::SPIRType::BaseType type)

Public Attributes
std::string	type
spirv_cross::SPIRType::BaseType	base_type
std::string	name
size_t	offset = 0u
size_t	size = 0u
size_t	byte_length = 0u
std::optional< size_t >	array_elements = std::nullopt
size_t	element_padding = 0u
std::optional< std::string >	float_type = std::nullopt
size_t	vec_size = 0u
size_t	columns = 0u
UnderlyingType	underlying_type = UnderlyingType::kOther

Detailed Description

Definition at line 25 of file reflector.h.

Member Enumeration Documentation

UnderlyingType

enum class impeller::compiler::StructMember::UnderlyingType

strong

Enumerator
kPadding
kFloat
kOther

Definition at line 28 of file reflector.h.

                            {
    kPadding,
    kFloat,
    kOther,
  };

Constructor & Destructor Documentation

StructMember()

impeller::compiler::StructMember::StructMember ( std::string  p_type, spirv_cross::SPIRType::BaseType  p_base_type, std::string  p_name, size_t  p_offset, size_t  p_size, size_t  p_byte_length, std::optional< size_t >  p_array_elements, size_t  p_element_padding, std::optional< std::string >  p_float_type = std::nullopt, size_t  p_vec_size = 0u, size_t  p_columns = 0u, UnderlyingType  p_underlying_type = UnderlyingType::kOther  )

inline

Constructs a new StructMember.

Parameters

p_type	The string type name (e.g. "float", "Point", "Matrix").
p_base_type	The SPIR-V base type.
p_name	The name of the struct member.
p_offset	The offset in bytes from the start of the parent struct.
p_size	The size in bytes of a single element of this type (ignoring padding/stride).
p_byte_length	The total size in bytes this member occupies in the struct, including all array elements and padding.
p_array_elements	The number of array elements. For matrices treated as arrays of columns, this includes the column count.
p_element_padding	The padding in bytes after each array element to satisfy alignment requirements (stride - size).
p_float_type	The float type of the member.
p_vec_size	The component count of a single column (vector length for non-matrix types, row count for matrices). 0 if not applicable.
p_columns	The number of columns. 1 for scalars and vectors; N for an NxN matrix. 0 if not applicable.
p_underlying_type	The underlying type category, used for runtime validation.

Definition at line 154 of file reflector.h.

      : type(std::move(p_type)),
        base_type(p_base_type),
        name(std::move(p_name)),
        offset(p_offset),
        size(p_size),
        byte_length(p_byte_length),
        array_elements(p_array_elements),
        element_padding(p_element_padding),
        float_type(std::move(p_float_type)),
        vec_size(p_vec_size),
        columns(p_columns),
        underlying_type(DetermineUnderlyingType(p_base_type)) {}

Member Function Documentation

BaseTypeToString()

static std::string impeller::compiler::StructMember::BaseTypeToString ( spirv_cross::SPIRType::BaseType  type )

inlinestatic

Definition at line 52 of file reflector.h.

                                                                      {
    using Type = spirv_cross::SPIRType::BaseType;
    switch (type) {
      case Type::Void:
        return "ShaderType::kVoid";
      case Type::Boolean:
        return "ShaderType::kBoolean";
      case Type::SByte:
        return "ShaderType::kSignedByte";
      case Type::UByte:
        return "ShaderType::kUnsignedByte";
      case Type::Short:
        return "ShaderType::kSignedShort";
      case Type::UShort:
        return "ShaderType::kUnsignedShort";
      case Type::Int:
        return "ShaderType::kSignedInt";
      case Type::UInt:
        return "ShaderType::kUnsignedInt";
      case Type::Int64:
        return "ShaderType::kSignedInt64";
      case Type::UInt64:
        return "ShaderType::kUnsignedInt64";
      case Type::AtomicCounter:
        return "ShaderType::kAtomicCounter";
      case Type::Half:
        return "ShaderType::kHalfFloat";
      case Type::Float:
        return "ShaderType::kFloat";
      case Type::Double:
        return "ShaderType::kDouble";
      case Type::Struct:
        return "ShaderType::kStruct";
      case Type::Image:
        return "ShaderType::kImage";
      case Type::SampledImage:
        return "ShaderType::kSampledImage";
      case Type::Sampler:
        return "ShaderType::kSampler";
      default:
        return "ShaderType::kUnknown";
    }
    FML_UNREACHABLE();
  }

References FML_UNREACHABLE, and type.

DetermineUnderlyingType()

static UnderlyingType impeller::compiler::StructMember::DetermineUnderlyingType ( spirv_cross::SPIRType::BaseType  type )

inlinestatic

Definition at line 97 of file reflector.h.

                                        {
    switch (type) {
      case spirv_cross::SPIRType::Void:
        return UnderlyingType::kPadding;
      case spirv_cross::SPIRType::Float:
        return UnderlyingType::kFloat;
      case spirv_cross::SPIRType::Unknown:
      case spirv_cross::SPIRType::Boolean:
      case spirv_cross::SPIRType::SByte:
      case spirv_cross::SPIRType::UByte:
      case spirv_cross::SPIRType::Short:
      case spirv_cross::SPIRType::UShort:
      case spirv_cross::SPIRType::Int:
      case spirv_cross::SPIRType::UInt:
      case spirv_cross::SPIRType::Int64:
      case spirv_cross::SPIRType::UInt64:
      case spirv_cross::SPIRType::AtomicCounter:
      case spirv_cross::SPIRType::Half:
      case spirv_cross::SPIRType::Double:
      case spirv_cross::SPIRType::Struct:
      case spirv_cross::SPIRType::Image:
      case spirv_cross::SPIRType::SampledImage:
      case spirv_cross::SPIRType::Sampler:
      case spirv_cross::SPIRType::AccelerationStructure:
      case spirv_cross::SPIRType::RayQuery:
      case spirv_cross::SPIRType::ControlPointArray:
      case spirv_cross::SPIRType::Interpolant:
      case spirv_cross::SPIRType::Char:
      default:
        return UnderlyingType::kOther;
    }
    FML_UNREACHABLE();
  }

References FML_UNREACHABLE, kFloat, kOther, kPadding, and type.

Member Data Documentation

array_elements

std::optional<size_t> impeller::compiler::StructMember::array_elements = std::nullopt

Definition at line 40 of file reflector.h.

base_type

spirv_cross::SPIRType::BaseType impeller::compiler::StructMember::base_type

Definition at line 35 of file reflector.h.

byte_length

size_t impeller::compiler::StructMember::byte_length = 0u

Definition at line 39 of file reflector.h.

columns

size_t impeller::compiler::StructMember::columns = 0u

Definition at line 49 of file reflector.h.

element_padding

size_t impeller::compiler::StructMember::element_padding = 0u

Definition at line 41 of file reflector.h.

float_type

std::optional<std::string> impeller::compiler::StructMember::float_type = std::nullopt

Definition at line 42 of file reflector.h.

name

std::string impeller::compiler::StructMember::name

Definition at line 36 of file reflector.h.

offset

size_t impeller::compiler::StructMember::offset = 0u

Definition at line 37 of file reflector.h.

size

size_t impeller::compiler::StructMember::size = 0u

Definition at line 38 of file reflector.h.

type

std::string impeller::compiler::StructMember::type

Definition at line 34 of file reflector.h.

Referenced by BaseTypeToString(), and DetermineUnderlyingType().

underlying_type

UnderlyingType impeller::compiler::StructMember::underlying_type = UnderlyingType::kOther

Definition at line 50 of file reflector.h.

vec_size

size_t impeller::compiler::StructMember::vec_size = 0u

Definition at line 47 of file reflector.h.

---

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

• impeller/compiler/reflector.h