Skip to content

Commit f5da6d6

Browse files
Site changes [skip-ci]
1 parent af5dc7d commit f5da6d6

5 files changed

Lines changed: 116 additions & 2 deletions
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"elements": [
3+
{
4+
"brief": "Get the render light prototype for a loaded light resource",
5+
"description": "Returns the <code>dmRender::HLightPrototype</code> handle created from the <code>.lightc</code> data.\nThe pointer remains valid until the resource is released.",
6+
"error": "",
7+
"examples": "",
8+
"language": "",
9+
"members": [],
10+
"name": "GetLightPrototype",
11+
"notes": [],
12+
"parameters": [
13+
{
14+
"doc": "Light resource",
15+
"is_optional": "False",
16+
"name": "res",
17+
"types": [
18+
"LightResource*"
19+
]
20+
}
21+
],
22+
"replaces": "",
23+
"returnvalues": [
24+
{
25+
"doc": "Prototype pointer",
26+
"name": "prototype",
27+
"types": [
28+
"dmRender::HLightPrototype*"
29+
]
30+
}
31+
],
32+
"tparams": [],
33+
"type": "FUNCTION"
34+
},
35+
{
36+
"brief": "Opaque handle to a loaded light resource",
37+
"description": "This struct is an opaque handle managed by the engine.",
38+
"error": "",
39+
"examples": "",
40+
"language": "",
41+
"members": [],
42+
"name": "LightResource",
43+
"notes": [],
44+
"parameters": [],
45+
"replaces": "",
46+
"returnvalues": [],
47+
"tparams": [],
48+
"type": "STRUCT"
49+
}
50+
],
51+
"info": {
52+
"brief": "Light resource access",
53+
"description": "Helper types and accessors for the light resource type (`.lightc`).",
54+
"description_html": "<p>Helper types and accessors for the light resource type (<code>.lightc</code>).</p>",
55+
"file": "res_light.h",
56+
"include": "dmsdk/gamesys/resources/res_light.h",
57+
"language": "C++",
58+
"name": "Light Resource",
59+
"namespace": "dmGameSystem",
60+
"notes": [],
61+
"path": "engine/gamesys/src/dmsdk/gamesys/resources/res_light.h",
62+
"type": "Defold C++"
63+
}
64+
}

_data/ref/alpha/engine-render-src-dmsdk-render-render-h.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -876,6 +876,21 @@
876876
"tparams": [],
877877
"type": "TYPEDEF"
878878
},
879+
{
880+
"brief": "Light prototype handle. Used to create light insta...",
881+
"description": "Light prototype handle. Used to create light instances.",
882+
"error": "",
883+
"examples": "",
884+
"language": "",
885+
"members": [],
886+
"name": "HLightPrototype",
887+
"notes": [],
888+
"parameters": [],
889+
"replaces": "",
890+
"returnvalues": [],
891+
"tparams": [],
892+
"type": "TYPEDEF"
893+
},
879894
{
880895
"brief": "Material instance handle",
881896
"description": "Material instance handle",
@@ -936,6 +951,21 @@
936951
"tparams": [],
937952
"type": "TYPEDEF"
938953
},
954+
{
955+
"brief": "Sampler handle",
956+
"description": "Sampler handle",
957+
"error": "",
958+
"examples": "",
959+
"language": "",
960+
"members": [],
961+
"name": "HSampler",
962+
"notes": [],
963+
"parameters": [],
964+
"replaces": "",
965+
"returnvalues": [],
966+
"tparams": [],
967+
"type": "TYPEDEF"
968+
},
939969
{
940970
"brief": "Iterates over the constants",
941971
"description": "Iterates over the constants",

_data/refindex.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3023,6 +3023,17 @@
30233023
"type": "Defold Lua",
30243024
"url": "/ref/stable/label-lua"
30253025
},
3026+
{
3027+
"branch": "alpha",
3028+
"file": "res_light.h",
3029+
"filename": "engine-gamesys-src-dmsdk-gamesys-resources-res_light-h",
3030+
"language": "C++",
3031+
"name": "Light Resource",
3032+
"namespace": "dmGameSystem",
3033+
"path": "engine/gamesys/src/dmsdk/gamesys/resources/res_light.h",
3034+
"type": "Defold C++",
3035+
"url": "/ref/alpha/engine-gamesys-src-dmsdk-gamesys-resources-res_light-h"
3036+
},
30263037
{
30273038
"branch": "stable",
30283039
"file": "script_liveupdate.h",

ref/alpha/dmgamesystem.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: api
33
branch: alpha
4-
ref: engine-gamesys-src-dmsdk-gamesys-resources-res_font-h
4+
ref: engine-gamesys-src-dmsdk-gamesys-resources-res_light-h
55
language: C++
6-
title: API reference (Font Resource)
6+
title: API reference (Light Resource)
77
type: Defold C++
88
pagefind_exclude: true
99
---
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
layout: api
3+
branch: alpha
4+
ref: engine-gamesys-src-dmsdk-gamesys-resources-res_light-h
5+
language: C++
6+
title: API reference (Light Resource)
7+
type: Defold C++
8+
---
9+
{% include anchor_headings.html html=content %}

0 commit comments

Comments
 (0)