Plasma Engine  2.0
Loading...
Searching...
No Matches
plPropertyFlags Struct Reference

Flags used to describe a property and its type. More...

#include <AbstractProperty.h>

Classes

struct  Bits
 

Public Types

enum  Enum : plUInt16 {
  StandardType = PL_BIT(0) , IsEnum = PL_BIT(1) , Bitflags = PL_BIT(2) , Class = PL_BIT(3) ,
  Const = PL_BIT(4) , Reference = PL_BIT(5) , Pointer = PL_BIT(6) , PointerOwner = PL_BIT(7) ,
  ReadOnly = PL_BIT(8) , Hidden = PL_BIT(9) , Phantom = PL_BIT(10) , VarOut = PL_BIT(11) ,
  VarInOut = PL_BIT(12) , Default = 0 , Void = 0
}
 
using StorageType = plUInt16
 

Static Public Member Functions

template<class Type >
static plBitflags< plPropertyFlagsGetParameterFlags ()
 
template<>
plBitflags< plPropertyFlagsGetParameterFlags ()
 

Detailed Description

Flags used to describe a property and its type.

Member Enumeration Documentation

◆ Enum

enum plPropertyFlags::Enum : plUInt16
Enumerator
StandardType 

Anything that can be stored inside an plVariant except for pointers and containers.

IsEnum 

enum property, cast to plAbstractEnumerationProperty.

Bitflags 

Bitflags property, cast to plAbstractEnumerationProperty.

Class 

A struct or class. All of the above are mutually exclusive.

Const 

Property value is const.

Reference 

Property value is a reference.

Pointer 

Property value is a pointer.

PointerOwner 

This pointer property takes ownership of the passed pointer.

ReadOnly 

Can only be read but not modified.

Hidden 

This property should not appear in the UI.

Phantom 

Phantom types are mirrored types on the editor side. Ie. they do not exist as actual classes in the process. Also used for data driven types, e.g. by the Visual Shader asset.

VarOut 

Tag for non-const-ref function parameters to indicate usage 'out'.

VarInOut 

Tag for non-const-ref function parameters to indicate usage 'inout'.


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