Skip to content

Documentation / device / PBFunctionTypeInfo

Class: PBFunctionTypeInfo

Defined in: libs/device/src/builder/types.ts:1676

The function type info

Extends

Constructors

Constructor

new PBFunctionTypeInfo(name, returnType, argTypes): PBFunctionTypeInfo

Defined in: libs/device/src/builder/types.ts:1677

Parameters

name

string

returnType

PBTypeInfo

argTypes

object[]

Returns

PBFunctionTypeInfo

Overrides

PBTypeInfo<FunctionTypeDetail>.constructor

Accessors

typeId

Get Signature

get typeId(): string

Defined in: libs/device/src/builder/types.ts:585

Get unique id for this type

Returns

string

Inherited from

PBTypeInfo.typeId


name

Get Signature

get name(): string

Defined in: libs/device/src/builder/types.ts:1685

Get name of the function

Returns

string


returnType

Get Signature

get returnType(): PBTypeInfo<TypeDetailInfo>

Defined in: libs/device/src/builder/types.ts:1689

Get return type of the function

Returns

PBTypeInfo<TypeDetailInfo>


argTypes

Get Signature

get argTypes(): object[]

Defined in: libs/device/src/builder/types.ts:1693

Get all the argument types for this function

Returns

argHash

Get Signature

get argHash(): string

Defined in: libs/device/src/builder/types.ts:1697

Get hash for parameter types

Returns

string

Methods

isVoidType()

isVoidType(): this is PBVoidTypeInfo

Defined in: libs/device/src/builder/types.ts:592

returns true if this is a void type

Returns

this is PBVoidTypeInfo

Inherited from

PBTypeInfo.isVoidType


isAnyType()

isAnyType(): this is PBAnyTypeInfo

Defined in: libs/device/src/builder/types.ts:596

returns true if this is an any type

Returns

this is PBAnyTypeInfo

Inherited from

PBTypeInfo.isAnyType


isPrimitiveType()

isPrimitiveType(): this is PBPrimitiveTypeInfo

Defined in: libs/device/src/builder/types.ts:600

returns true if this is a primitive type

Returns

this is PBPrimitiveTypeInfo

Inherited from

PBTypeInfo.isPrimitiveType


haveAtomicMembers()

haveAtomicMembers(): boolean

Defined in: libs/device/src/builder/types.ts:604

Wether this type have atomic members

Returns

boolean

Inherited from

PBTypeInfo.haveAtomicMembers


isStructType()

isStructType(): this is PBStructTypeInfo

Defined in: libs/device/src/builder/types.ts:608

returns true if this is a struct type

Returns

this is PBStructTypeInfo

Inherited from

PBTypeInfo.isStructType


isArrayType()

isArrayType(): this is PBArrayTypeInfo

Defined in: libs/device/src/builder/types.ts:612

returns true if this is an array type

Returns

this is PBArrayTypeInfo

Inherited from

PBTypeInfo.isArrayType


isPointerType()

isPointerType(): this is PBPointerTypeInfo

Defined in: libs/device/src/builder/types.ts:616

returns true if this is a pointer type

Returns

this is PBPointerTypeInfo

Inherited from

PBTypeInfo.isPointerType


isAtomicI32()

isAtomicI32(): this is PBAtomicI32TypeInfo

Defined in: libs/device/src/builder/types.ts:620

returns true if this is an atomic int type

Returns

this is PBAtomicI32TypeInfo

Inherited from

PBTypeInfo.isAtomicI32


isAtomicU32()

isAtomicU32(): this is PBAtomicU32TypeInfo

Defined in: libs/device/src/builder/types.ts:624

returns true if this is an atomic uint type

Returns

this is PBAtomicU32TypeInfo

Inherited from

PBTypeInfo.isAtomicU32


isSamplerType()

isSamplerType(): this is PBSamplerTypeInfo

Defined in: libs/device/src/builder/types.ts:628

returns true if this is a sampler type

Returns

this is PBSamplerTypeInfo

Inherited from

PBTypeInfo.isSamplerType


isTextureType()

isTextureType(): this is PBTextureTypeInfo

Defined in: libs/device/src/builder/types.ts:632

returns true if this is a texture type

Returns

this is PBTextureTypeInfo

Inherited from

PBTypeInfo.isTextureType


isCompatibleType()

isCompatibleType(other): boolean

Defined in: libs/device/src/builder/types.ts:656

Check whether a given type is compatible with this type

Parameters

other

PBTypeInfo

The type to be checked

Returns

boolean

true if the given type is compatible with this type, othewise false

Inherited from

PBTypeInfo.isCompatibleType


toBufferLayout()

toBufferLayout(_offset): any

Defined in: libs/device/src/builder/types.ts:1705

Creates a buffer layout from this type

Parameters

_offset

number

Byte offset of the layout

Returns

any

The created buffer layout

Overrides

PBTypeInfo.toBufferLayout

Released under the MIT License.