Lightgraph
C++17 light-graph engine API reference
Loading...
Searching...
No Matches
lightgraph::integration Namespace Reference

Typedefs

using TopologySnapshot = ::TopologySnapshot
 
using TopologyIntersectionSnapshot = ::TopologyIntersectionSnapshot
 
using TopologyConnectionSnapshot = ::TopologyConnectionSnapshot
 
using TopologyPortSnapshot = ::TopologyPortSnapshot
 
using TopologyModelSnapshot = ::TopologyModelSnapshot
 
using TopologyWeightSnapshot = ::TopologyPortWeightSnapshot
 
using TopologyWeightConditionalSnapshot = ::TopologyWeightConditionalSnapshot
 
using TopologyGapSnapshot = ::PixelGap
 
using TopologyPortType = ::TopologyPortType
 
using TopologyPixels = ::TopologyPixels
 
using Debugger = ::Debugger
 
using PaletteView = ::PaletteView
 
using LayerView = ::LayerView
 
using HeptagonStar = ::HeptagonStar
 
using Heptagon919 = ::Heptagon919
 
using Heptagon3024 = ::Heptagon3024
 
using Line = ::Line
 
using Cross = ::Cross
 
using Triangle = ::Triangle
 
using HeptagonStarModel = ::HeptagonStarModel
 
using LineModel = ::LineModel
 
using CrossModel = ::CrossModel
 
using TriangleModel = ::TriangleModel
 
using AllocationFailureSite = ::LightgraphAllocationFailureSite
 
using AllocationFailureObserver = ::LightgraphAllocationFailureObserver
 
using Palette = ::Palette
 
using EmitParam = ::EmitParam
 
using EmitParams = ::EmitParams
 
using Behaviour = ::Behaviour
 
using RuntimeLight = ::RuntimeLight
 
using Light = ::Light
 
using LightList = ::LightList
 
using BgLight = ::BgLight
 
using RuntimeState = ::State
 
using Owner = ::Owner
 
using Port = ::Port
 
using InternalPort = ::InternalPort
 
using ExternalPort = ::ExternalPort
 
using Weight = ::Weight
 
using Model = ::Model
 
using Intersection = ::Intersection
 
using Connection = ::Connection
 
using Object = ::TopologyObject
 
using PixelGap = ::PixelGap
 
using TopologySummary = ::TopologySummary
 
using TopologySummaryIntersection = ::TopologySummaryIntersection
 
using TopologySummaryConnection = ::TopologySummaryConnection
 
using TopologySummaryPort = ::TopologySummaryPort
 
using TopologySummaryModel = ::TopologySummaryModel
 

Enumerations

enum class  BuiltinObjectType {
  Heptagon919 , Heptagon3024 , Line , Cross ,
  Triangle
}
 

Functions

std::unique_ptr< ObjectmakeObject (BuiltinObjectType type, uint16_t pixelCount=0)
 Create one of the built-in topology objects.
 
PaletteView paletteView (const Palette &palette)
 
Palette paletteFromView (const PaletteView &view)
 
PaletteView normalizePalette (const PaletteView &view)
 
std::vector< LayerViewlayerViews (const RuntimeState &state, bool editableOnly=false)
 
void setAllocationFailureObserver (AllocationFailureObserver observer)
 
void setAllocationFailureObserver (::TopologyObject &object, AllocationFailureObserver observer)
 
void reportAllocationFailure (AllocationFailureSite site, uint16_t detail0=0, uint16_t detail1=0)
 
void reportAllocationFailure (::TopologyObject &object, AllocationFailureSite site, uint16_t detail0=0, uint16_t detail1=0)
 
constexpr uint8_t predefinedPaletteNameCount ()
 
constexpr const charpredefinedPaletteNameAt (uint8_t index)
 
uint8_t paletteCount ()
 Return the number of built-in palettes.
 
Palette paletteAt (uint8_t index)
 Get a built-in palette by index.
 
TopologySummary summarizeTopology (const Object &object)
 

Variables

constexpr uint16_t kHeptagon919PixelCount = HEPTAGON919_PIXEL_COUNT
 
constexpr uint16_t kHeptagon3024PixelCount = HEPTAGON3024_PIXEL_COUNT
 
constexpr uint16_t kLinePixelCount = LINE_PIXEL_COUNT
 
constexpr uint16_t kCrossPixelCount = CROSS_PIXEL_COUNT
 
constexpr uint16_t kTrianglePixelCount = TRIANGLE_PIXEL_COUNT
 
constexpr const charkPredefinedPaletteNames []
 
constexpr int8_t kWrapNoWrap = WRAP_NOWRAP
 
constexpr int8_t kWrapClampToEdge = WRAP_CLAMP_TO_EDGE
 
constexpr int8_t kWrapRepeat = WRAP_REPEAT
 
constexpr int8_t kWrapRepeatMirror = WRAP_REPEAT_MIRROR
 

Typedef Documentation

◆ AllocationFailureObserver

using lightgraph::integration::AllocationFailureObserver = typedef ::LightgraphAllocationFailureObserver

Definition at line 14 of file observability.hpp.

◆ AllocationFailureSite

using lightgraph::integration::AllocationFailureSite = typedef ::LightgraphAllocationFailureSite

Definition at line 13 of file observability.hpp.

◆ Behaviour

Definition at line 16 of file runtime.hpp.

◆ BgLight

Definition at line 20 of file runtime.hpp.

◆ Connection

Definition at line 19 of file topology.hpp.

◆ Cross

Definition at line 18 of file objects.hpp.

◆ CrossModel

Definition at line 23 of file objects.hpp.

◆ Debugger

Definition at line 13 of file debug.hpp.

◆ EmitParam

Definition at line 14 of file runtime.hpp.

◆ EmitParams

Definition at line 15 of file runtime.hpp.

◆ ExternalPort

Definition at line 15 of file topology.hpp.

◆ Heptagon3024

Definition at line 16 of file objects.hpp.

◆ Heptagon919

Definition at line 15 of file objects.hpp.

◆ HeptagonStar

Definition at line 14 of file objects.hpp.

◆ HeptagonStarModel

Definition at line 21 of file objects.hpp.

◆ InternalPort

Definition at line 14 of file topology.hpp.

◆ Intersection

Definition at line 18 of file topology.hpp.

◆ LayerView

Definition at line 14 of file layers.hpp.

◆ Light

Definition at line 18 of file runtime.hpp.

◆ LightList

Definition at line 19 of file runtime.hpp.

◆ Line

Definition at line 17 of file objects.hpp.

◆ LineModel

Definition at line 22 of file objects.hpp.

◆ Model

Definition at line 17 of file topology.hpp.

◆ Object

Definition at line 20 of file topology.hpp.

◆ Owner

Definition at line 12 of file topology.hpp.

◆ Palette

Definition at line 12 of file rendering.hpp.

◆ PaletteView

Definition at line 13 of file layers.hpp.

◆ PixelGap

Definition at line 21 of file topology.hpp.

◆ Port

Definition at line 13 of file topology.hpp.

◆ RuntimeLight

Definition at line 17 of file runtime.hpp.

◆ RuntimeState

Definition at line 21 of file runtime.hpp.

◆ TopologyConnectionSnapshot

Definition at line 15 of file codecs.hpp.

◆ TopologyGapSnapshot

◆ TopologyIntersectionSnapshot

Definition at line 14 of file codecs.hpp.

◆ TopologyModelSnapshot

Definition at line 17 of file codecs.hpp.

◆ TopologyPixels

Definition at line 12 of file debug.hpp.

◆ TopologyPortSnapshot

Definition at line 16 of file codecs.hpp.

◆ TopologyPortType

Definition at line 21 of file codecs.hpp.

◆ TopologySnapshot

Definition at line 13 of file codecs.hpp.

◆ TopologySummary

Definition at line 14 of file topology_summary.hpp.

◆ TopologySummaryConnection

Definition at line 16 of file topology_summary.hpp.

◆ TopologySummaryIntersection

Definition at line 15 of file topology_summary.hpp.

◆ TopologySummaryModel

Definition at line 18 of file topology_summary.hpp.

◆ TopologySummaryPort

Definition at line 17 of file topology_summary.hpp.

◆ TopologyWeightConditionalSnapshot

Definition at line 19 of file codecs.hpp.

◆ TopologyWeightSnapshot

Definition at line 18 of file codecs.hpp.

◆ Triangle

Definition at line 19 of file objects.hpp.

◆ TriangleModel

Definition at line 24 of file objects.hpp.

◆ Weight

Definition at line 16 of file topology.hpp.

Enumeration Type Documentation

◆ BuiltinObjectType

Enumerator
Heptagon919 
Heptagon3024 
Line 
Cross 
Triangle 

Definition at line 11 of file object_factory.hpp.

Function Documentation

◆ layerViews()

std::vector< LayerView > lightgraph::integration::layerViews ( const RuntimeState state,
bool  editableOnly = false 
)
inline

Definition at line 28 of file layers.hpp.

◆ makeObject()

std::unique_ptr< Object > lightgraph::integration::makeObject ( BuiltinObjectType  type,
uint16_t  pixelCount = 0 
)
inline

Create one of the built-in topology objects.

Parameters
typeBuilt-in object kind.
pixelCountOptional pixel count override for line/cross/triangle.

Definition at line 21 of file factory.hpp.

References lightgraph::internal::makeBuiltinObject().

◆ normalizePalette()

PaletteView lightgraph::integration::normalizePalette ( const PaletteView view)
inline

Definition at line 24 of file layers.hpp.

◆ paletteAt()

Palette lightgraph::integration::paletteAt ( uint8_t  index)
inline

Get a built-in palette by index.

Definition at line 27 of file rendering.hpp.

◆ paletteCount()

uint8_t lightgraph::integration::paletteCount ( )
inline

Return the number of built-in palettes.

Definition at line 22 of file rendering.hpp.

◆ paletteFromView()

Palette lightgraph::integration::paletteFromView ( const PaletteView view)
inline

Definition at line 20 of file layers.hpp.

◆ paletteView()

PaletteView lightgraph::integration::paletteView ( const Palette palette)
inline

Definition at line 16 of file layers.hpp.

◆ predefinedPaletteNameAt()

constexpr const char * lightgraph::integration::predefinedPaletteNameAt ( uint8_t  index)
inlineconstexpr

Definition at line 53 of file palette_names.hpp.

References kPredefinedPaletteNames, and predefinedPaletteNameCount().

◆ predefinedPaletteNameCount()

constexpr uint8_t lightgraph::integration::predefinedPaletteNameCount ( )
inlineconstexpr

Definition at line 49 of file palette_names.hpp.

References kPredefinedPaletteNames.

Referenced by predefinedPaletteNameAt().

◆ reportAllocationFailure() [1/2]

void lightgraph::integration::reportAllocationFailure ( ::TopologyObject &  object,
AllocationFailureSite  site,
uint16_t  detail0 = 0,
uint16_t  detail1 = 0 
)
inline

Definition at line 28 of file observability.hpp.

◆ reportAllocationFailure() [2/2]

void lightgraph::integration::reportAllocationFailure ( AllocationFailureSite  site,
uint16_t  detail0 = 0,
uint16_t  detail1 = 0 
)
inline

Definition at line 24 of file observability.hpp.

◆ setAllocationFailureObserver() [1/2]

void lightgraph::integration::setAllocationFailureObserver ( ::TopologyObject &  object,
AllocationFailureObserver  observer 
)
inline

Definition at line 20 of file observability.hpp.

◆ setAllocationFailureObserver() [2/2]

void lightgraph::integration::setAllocationFailureObserver ( AllocationFailureObserver  observer)
inline

Definition at line 16 of file observability.hpp.

◆ summarizeTopology()

TopologySummary lightgraph::integration::summarizeTopology ( const Object object)
inline

Definition at line 20 of file topology_summary.hpp.

Variable Documentation

◆ kCrossPixelCount

constexpr uint16_t lightgraph::integration::kCrossPixelCount = CROSS_PIXEL_COUNT
constexpr

Definition at line 29 of file objects.hpp.

◆ kHeptagon3024PixelCount

constexpr uint16_t lightgraph::integration::kHeptagon3024PixelCount = HEPTAGON3024_PIXEL_COUNT
constexpr

Definition at line 27 of file objects.hpp.

◆ kHeptagon919PixelCount

constexpr uint16_t lightgraph::integration::kHeptagon919PixelCount = HEPTAGON919_PIXEL_COUNT
constexpr

Definition at line 26 of file objects.hpp.

◆ kLinePixelCount

constexpr uint16_t lightgraph::integration::kLinePixelCount = LINE_PIXEL_COUNT
constexpr

Definition at line 28 of file objects.hpp.

◆ kPredefinedPaletteNames

constexpr const char* lightgraph::integration::kPredefinedPaletteNames[]
inlineconstexpr

Definition at line 13 of file palette_names.hpp.

Referenced by predefinedPaletteNameAt(), and predefinedPaletteNameCount().

◆ kTrianglePixelCount

constexpr uint16_t lightgraph::integration::kTrianglePixelCount = TRIANGLE_PIXEL_COUNT
constexpr

Definition at line 30 of file objects.hpp.

◆ kWrapClampToEdge

constexpr int8_t lightgraph::integration::kWrapClampToEdge = WRAP_CLAMP_TO_EDGE
constexpr

Definition at line 15 of file rendering.hpp.

◆ kWrapNoWrap

constexpr int8_t lightgraph::integration::kWrapNoWrap = WRAP_NOWRAP
constexpr

Definition at line 14 of file rendering.hpp.

◆ kWrapRepeat

constexpr int8_t lightgraph::integration::kWrapRepeat = WRAP_REPEAT
constexpr

Definition at line 16 of file rendering.hpp.

◆ kWrapRepeatMirror

constexpr int8_t lightgraph::integration::kWrapRepeatMirror = WRAP_REPEAT_MIRROR
constexpr

Definition at line 17 of file rendering.hpp.