An attribute that specifies the information regarding the interface variable: descriptor set, binding, storage class. More...

#include "mlir/Dialect/SPIRV/IR/SPIRVAttributes.h"

Inheritance diagram for mlir::spirv::InterfaceVarABIAttr:

Public Types
using	Base = StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits... >
	Utility declarations for the concrete attribute class. More...

Public Types inherited from mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >
using	Base = StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits... >
	Utility declarations for the concrete attribute class. More...

using	ImplType = StorageT

using	HasTraitFn = bool(*)(TypeID)

Public Member Functions
uint32_t	getDescriptorSet ()
	Returns descriptor set. More...

uint32_t	getBinding ()
	Returns binding. More...

std::optional< StorageClass >	getStorageClass ()
	Returns `spirv::StorageClass`. More...

Public Member Functions inherited from mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >
ImplType *	getImpl () const
	Utility for easy access to the storage instance. More...

Static Public Member Functions
static InterfaceVarABIAttr	get (uint32_t descriptorSet, uint32_t binding, std::optional< StorageClass > storageClass, MLIRContext *context)
	Gets a InterfaceVarABIAttr. More...

static InterfaceVarABIAttr	get (IntegerAttr descriptorSet, IntegerAttr binding, IntegerAttr storageClass)

static StringRef	getKindName ()
	Returns the attribute kind's name (without the 'spirv.' prefix). More...

static LogicalResult	verifyInvariants (function_ref< InFlightDiagnostic()> emitError, IntegerAttr descriptorSet, IntegerAttr binding, IntegerAttr storageClass)

Static Public Member Functions inherited from mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >
static TypeID	getTypeID ()
	Return a unique identifier for the concrete type. More...

template<typename T >
static bool	classof (T val)
	Provide an implementation of 'classof' that compares the type id of the provided value with that of the concrete type. More...

static detail::InterfaceMap	getInterfaceMap ()
	Returns an interface map for the interfaces registered to this storage user. More...

static HasTraitFn	getHasTraitFn ()
	Returns the function that returns true if the given Trait ID matches the IDs of any of the traits defined by the storage user. More...

static auto	getWalkImmediateSubElementsFn ()
	Returns a function that walks immediate sub elements of a given instance of the storage user. More...

static auto	getReplaceImmediateSubElementsFn ()
	Returns a function that replaces immediate sub elements of a given instance of the storage user. More...

template<typename... IfaceModels>
static void	attachInterface (MLIRContext &context)
	Attach the given models as implementations of the corresponding interfaces for the concrete storage user class. More...

template<typename... Args>
static ConcreteT	get (MLIRContext *ctx, Args &&...args)
	Get or create a new ConcreteT instance within the ctx. More...

template<typename... Args>
static ConcreteT	getChecked (const Location &loc, Args &&...args)
	Get or create a new ConcreteT instance within the ctx, defined at the given, potentially unknown, location. More...

template<typename... Args>
static ConcreteT	getChecked (function_ref< InFlightDiagnostic()> emitErrorFn, MLIRContext *ctx, Args... args)
	Get or create a new ConcreteT instance within the ctx. More...

static ConcreteT	getFromOpaquePointer (const void *ptr)
	Get an instance of the concrete type from a void pointer. More...

Static Public Attributes
static constexpr StringLiteral	name = "spirv.interface_var_abi"

Additional Inherited Members
Protected Member Functions inherited from mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >
template<typename... Args>
LogicalResult	mutate (Args &&...args)
	Mutate the current storage instance. More...

Static Protected Member Functions inherited from mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >
template<typename... Args>
static LogicalResult	verifyInvariants (Args... args)
	Default implementation that just returns success. More...

Detailed Description

An attribute that specifies the information regarding the interface variable: descriptor set, binding, storage class.

Definition at line 54 of file SPIRVAttributes.h.

Member Typedef Documentation

◆ Base

using mlir::detail::StorageUserBase< ConcreteT, BaseT, StorageT, UniquerT, Traits >::Base = StorageUserBase<ConcreteT, BaseT, StorageT, UniquerT, Traits...>

Utility declarations for the concrete attribute class.

Definition at line 100 of file StorageUniquerSupport.h.

Member Function Documentation

◆ get() [1/2]

spirv::InterfaceVarABIAttr spirv::InterfaceVarABIAttr::get	(	IntegerAttr	descriptorSet,
		IntegerAttr	binding,
		IntegerAttr	storageClass
	)

static

Definition at line 136 of file SPIRVAttributes.cpp.

References mlir::get().

◆ get() [2/2]

static InterfaceVarABIAttr mlir::spirv::InterfaceVarABIAttr::get	(	uint32_t	descriptorSet,
		uint32_t	binding,
		std::optional< StorageClass >	storageClass,
		MLIRContext *	context
	)

static

Gets a InterfaceVarABIAttr.

Referenced by parseInterfaceVarABIAttr().

◆ getBinding()

uint32_t spirv::InterfaceVarABIAttr::getBinding ( )

Returns binding.

Definition at line 147 of file SPIRVAttributes.cpp.

Referenced by createGlobalVarForEntryPointArgument(), and print().

◆ getDescriptorSet()

uint32_t spirv::InterfaceVarABIAttr::getDescriptorSet ( )

Returns descriptor set.

Definition at line 151 of file SPIRVAttributes.cpp.

Referenced by createGlobalVarForEntryPointArgument(), and print().

◆ getKindName()

StringRef spirv::InterfaceVarABIAttr::getKindName ( )

static

Returns the attribute kind's name (without the 'spirv.' prefix).

Definition at line 143 of file SPIRVAttributes.cpp.

Referenced by print().

◆ getStorageClass()

std::optional< spirv::StorageClass > spirv::InterfaceVarABIAttr::getStorageClass ( )

Returns spirv::StorageClass.

Definition at line 156 of file SPIRVAttributes.cpp.

Referenced by createGlobalVarForEntryPointArgument(), and print().

◆ verifyInvariants()

LogicalResult spirv::InterfaceVarABIAttr::verifyInvariants	(	function_ref< InFlightDiagnostic()>	emitError,
		IntegerAttr	descriptorSet,
		IntegerAttr	binding,
		IntegerAttr	storageClass
	)

static

Definition at line 165 of file SPIRVAttributes.cpp.

References mlir::emitError().

Member Data Documentation

◆ name

constexpr StringLiteral mlir::spirv::InterfaceVarABIAttr::name = "spirv.interface_var_abi"

staticconstexpr

Definition at line 84 of file SPIRVAttributes.h.

The documentation for this class was generated from the following files:

include/mlir/Dialect/SPIRV/IR/SPIRVAttributes.h
lib/Dialect/SPIRV/IR/SPIRVAttributes.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Member Function Documentation

◆ get() [1/2]

◆ get() [2/2]

◆ getBinding()

◆ getDescriptorSet()

◆ getKindName()

◆ getStorageClass()

◆ verifyInvariants()

Member Data Documentation

◆ name