annotate semicongine/material.nim @ 868:252cbc10b25f

did: improve/refactor some of the material API
author Sam <sam@basx.dev>
date Wed, 03 Jan 2024 11:19:55 +0700
parents 8fd450acc6f8
children 65afec4cb6c6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
840
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
1 import std/tables
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
2 import std/strformat
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
3 import std/strutils
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
4 import std/hashes
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
5
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
6
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
7 import ./core
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
8
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
9 type
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
10 MaterialType* = object
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
11 name*: string
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
12 vertexAttributes*: Table[string, DataType]
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
13 instanceAttributes*: Table[string, DataType]
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
14 attributes*: Table[string, DataType]
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
15 MaterialData* = object
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
16 theType*: MaterialType
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
17 name*: string
867
8fd450acc6f8 some fixes + some intermedite state
Sam <sam@basx.dev>
parents: 840
diff changeset
18 attributes: Table[string, DataList]
8fd450acc6f8 some fixes + some intermedite state
Sam <sam@basx.dev>
parents: 840
diff changeset
19
8fd450acc6f8 some fixes + some intermedite state
Sam <sam@basx.dev>
parents: 840
diff changeset
20 func hasMatchingAttribute*(materialType: MaterialType, attr: ShaderAttribute): bool =
8fd450acc6f8 some fixes + some intermedite state
Sam <sam@basx.dev>
parents: 840
diff changeset
21 return materialType.attributes.contains(attr.name) and materialType.attributes[attr.name] == attr.theType
8fd450acc6f8 some fixes + some intermedite state
Sam <sam@basx.dev>
parents: 840
diff changeset
22
8fd450acc6f8 some fixes + some intermedite state
Sam <sam@basx.dev>
parents: 840
diff changeset
23 func hasMatchingAttribute*(material: MaterialData, attr: ShaderAttribute): bool =
8fd450acc6f8 some fixes + some intermedite state
Sam <sam@basx.dev>
parents: 840
diff changeset
24 return material.attributes.contains(attr.name) and material.attributes[attr.name].theType == attr.theType
840
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
25
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
26 proc hash*(materialType: MaterialType): Hash =
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
27 return hash(materialType.name)
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
28
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
29 proc hash*(materialData: MaterialData): Hash =
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
30 return hash(materialData.name)
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
31
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
32 proc `==`*(a, b: MaterialType): bool =
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
33 return a.name == b.name
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
34
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
35 proc `==`*(a, b: MaterialData): bool =
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
36 return a.name == b.name
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
37
868
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
38 proc get*[T](material: MaterialData, attributeName: string): seq[T] =
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
39 getValues[T](material.attributes[attributeName])[]
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
40
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
41 proc getDataList*(material: MaterialData, attributeName: string): DataList =
867
8fd450acc6f8 some fixes + some intermedite state
Sam <sam@basx.dev>
parents: 840
diff changeset
42 material.attributes[attributeName]
8fd450acc6f8 some fixes + some intermedite state
Sam <sam@basx.dev>
parents: 840
diff changeset
43
868
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
44 proc getSingle*[T](material: MaterialData, attributeName: string): T =
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
45 getValues[T](material.attributes[attributeName])[][0]
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
46
840
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
47 let EMPTY_MATERIAL* = MaterialType(
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
48 name: "empty material",
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
49 vertexAttributes: {"position": Vec3F32}.toTable,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
50 )
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
51 let COLORED_MATERIAL* = MaterialType(
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
52 name: "single color material",
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
53 vertexAttributes: {"position": Vec3F32}.toTable,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
54 attributes: {"color": Vec4F32}.toTable,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
55 )
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
56 let VERTEX_COLORED_MATERIAL* = MaterialType(
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
57 name: "vertex color material",
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
58 vertexAttributes: {
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
59 "position": Vec3F32,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
60 "color": Vec4F32,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
61 }.toTable,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
62 )
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
63 let SINGLE_COLOR_MATERIAL* = MaterialType(
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
64 name: "single color material",
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
65 vertexAttributes: {
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
66 "position": Vec3F32,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
67 }.toTable,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
68 attributes: {"color": Vec4F32}.toTable
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
69 )
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
70 let SINGLE_TEXTURE_MATERIAL* = MaterialType(
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
71 name: "single texture material",
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
72 vertexAttributes: {
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
73 "position": Vec3F32,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
74 "uv": Vec2F32,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
75 }.toTable,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
76 attributes: {"baseTexture": TextureType}.toTable
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
77 )
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
78 let COLORED_SINGLE_TEXTURE_MATERIAL* = MaterialType(
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
79 name: "colored single texture material",
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
80 vertexAttributes: {
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
81 "position": Vec3F32,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
82 "uv": Vec2F32,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
83 }.toTable,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
84 attributes: {"baseTexture": TextureType, "color": Vec4F32}.toTable
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
85 )
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
86
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
87 proc `$`*(materialType: MaterialType): string =
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
88 var attributes: seq[string]
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
89 for key, value in materialType.attributes.pairs:
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
90 attributes.add &"{key}: {value}"
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
91 return &"""MaterialType '{materialType.name}' | Attributes: {attributes.join(", ")}"""
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
92
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
93 proc `$`*(material: MaterialData): string =
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
94 var attributes: seq[string]
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
95 for key, value in material.attributes.pairs:
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
96 attributes.add &"{key}: {value}"
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
97 return &"""Material '{material.name}' | Attributes: {attributes.join(", ")}"""
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
98
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
99 proc initMaterialData*(
868
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
100 theType: MaterialType,
840
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
101 name: string,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
102 attributes: Table[string, DataList],
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
103 ): MaterialData =
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
104 var theName = name
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
105 if theName == "":
868
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
106 theName = &"material instance of '{theType}'"
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
107 for matName, theType in theType.attributes.pairs:
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
108 assert attributes.contains(matName), &"missing material attribute '{matName}' for {theType}"
840
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
109 assert attributes[matName].theType == theType
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
110 MaterialData(
868
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
111 theType: theType,
840
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
112 name: theName,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
113 attributes: attributes,
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
114 )
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
115
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
116 proc initMaterialData*(
868
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
117 theType: MaterialType,
840
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
118 name: string = "",
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
119 attributes: openArray[(string, DataList)] = @[],
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
120 ): MaterialData =
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
121 var theName = name
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
122 if theName == "":
868
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
123 theName = &"material instance of '{theType}'"
252cbc10b25f did: improve/refactor some of the material API
Sam <sam@basx.dev>
parents: 867
diff changeset
124 initMaterialData(theType=theType, name=theName, attributes=attributes.toTable)
840
44ec744fbedc did: package restructuring according to nimble recommendation for libraries
Sam <sam@basx.dev>
parents:
diff changeset
125