Skip to content

Commit

Permalink
Site changes [skip-ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
@defold-services
defold-services committed Feb 10, 2025
1 parent 516d03b commit 922d40b
Show file tree
Hide file tree
Showing 9 changed files with 99 additions and 101 deletions.
2 changes: 1 addition & 1 deletion _data/ref/alpha/camera.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,7 @@
],
"info": {
"brief": "Camera API documentation",
"description": "Messages to control camera components and camera focus.",
"description": "Camera functions, messages and constants.",
"file": "",
"group": "COMPONENTS",
"language": "",
Expand Down
11 changes: 5 additions & 6 deletions _data/ref/alpha/dmGameObject.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4759,14 +4759,13 @@
}
],
"info": {
"brief": "Game object functions",
"description": "API for manipulating game objects",
"file": "dmsdk/gameobject/gameobject.h",
"group": "DEFOLD SDK",
"brief": "SDK GameObject script API documentation",
"description": "<span class=\"file\"><dmsdk/gameobject/script.h></span>",
"file": "",
"language": "",
"name": "Gameobject",
"name": "Script",
"namespace": "dmGameObject",
"notes": [],
"path": "engine/gameobject/src/dmsdk/gameobject/gameobject.h"
"path": ""
}
}
11 changes: 5 additions & 6 deletions _data/ref/alpha/dmGameSystem.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -514,14 +514,13 @@
}
],
"info": {
"brief": "SDK Gui Component API documentation",
"description": "Built-in scripting functions.",
"file": "dmsdk/gamesys/gui.h",
"group": "DEFOLD SDK",
"brief": "Component render constant API documentation",
"description": "<span class=\"file\"><dmsdk/gamesystem/render_constants.h></span>\nApi for setting and updating component render constants",
"file": "",
"language": "",
"name": "GameSystem Gui",
"name": "Component Render Constants",
"namespace": "dmGameSystem",
"notes": [],
"path": "engine/gamesys/src/dmsdk/gamesys/gui.h"
"path": ""
}
}
4 changes: 2 additions & 2 deletions _data/ref/alpha/dmGraphics.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2395,10 +2395,10 @@
],
"info": {
"brief": "Graphics API documentation",
"description": "<span class=\"file\"><dmsdk/graphics/graphics_vulkan.h></span>\nGraphics Vulkan API",
"description": "<span class=\"file\"><dmsdk/graphics/graphics_webgpu.h></span>\nGraphics WebGPU API",
"file": "",
"language": "",
"name": "Graphics Vulkan",
"name": "Graphics WebGPU",
"namespace": "dmGraphics",
"notes": [],
"path": ""
Expand Down
10 changes: 5 additions & 5 deletions _data/ref/alpha/dmMemory.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,14 +101,14 @@
}
],
"info": {
"brief": "SDK Memory API documentation",
"description": "Memory allocation functions",
"file": "dmsdk/dlib/memory.h",
"brief": "SDK Alloca API documentation",
"description": "Alloca functions.",
"file": "dmsdk/dlib/dalloca.h",
"group": "DEFOLD SDK",
"language": "",
"name": "Memory",
"name": "Alloca",
"namespace": "dmMemory",
"notes": [],
"path": "engine/dlib/src/dmsdk/dlib/memory.h"
"path": "engine/dlib/src/dmsdk/dlib/dalloca.h"
}
}
94 changes: 47 additions & 47 deletions _data/ref/alpha/dmResource.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"description": "Adds a file to the resource system\nAny request for this path will go through any existing mounts first.\nIf you wish to provide file overrides, please use the LiveUpdate feature for that.\nThe file isn't persisted between sessions.",
"error": "",
"examples": "",
"language": "C++",
"language": "",
"members": [],
"name": "AddFile",
"notes": [],
Expand All @@ -14,7 +14,7 @@
"doc": "Factory handle",
"name": "factory",
"types": [
"HResourceFactory"
"dmResource::HFactory"
]
},
{
Expand Down Expand Up @@ -42,10 +42,10 @@
"replaces": "",
"returnvalues": [
{
"doc": "RESULT_OK on success",
"name": "result",
"doc": "on success.",
"name": "RESULT_OK",
"types": [
"ResourceResult"
"dmResource::Result"
]
}
],
Expand All @@ -57,7 +57,7 @@
"description": "Adds a file to the resource system\nAny request for this path will go through any existing mounts first.\nIf you wish to provide file overrides, please use the LiveUpdate feature for that.\nThe file isn't persisted between sessions.",
"error": "",
"examples": "",
"language": "",
"language": "C++",
"members": [],
"name": "AddFile",
"notes": [],
Expand All @@ -66,7 +66,7 @@
"doc": "Factory handle",
"name": "factory",
"types": [
"dmResource::HFactory"
"HResourceFactory"
]
},
{
Expand Down Expand Up @@ -94,10 +94,10 @@
"replaces": "",
"returnvalues": [
{
"doc": "on success.",
"name": "RESULT_OK",
"doc": "RESULT_OK on success",
"name": "result",
"types": [
"dmResource::Result"
"ResourceResult"
]
}
],
Expand Down Expand Up @@ -248,7 +248,7 @@
"description": "Get a resource from factory",
"error": "",
"examples": "",
"language": "C++",
"language": "",
"members": [],
"name": "Get",
"notes": [],
Expand All @@ -257,7 +257,7 @@
"doc": "Factory handle",
"name": "factory",
"types": [
"HResourceFactory"
"dmResource::HFactory"
]
},
{
Expand All @@ -281,7 +281,7 @@
"doc": "RESULT_OK on success",
"name": "result",
"types": [
"ResourceResult"
"dmResource::Result"
]
}
],
Expand Down Expand Up @@ -309,7 +309,7 @@
"doc": "Resource name",
"name": "name",
"types": [
"const char*"
"dmhash_t"
]
},
{
Expand Down Expand Up @@ -338,7 +338,7 @@
"description": "Get a resource from factory",
"error": "",
"examples": "",
"language": "",
"language": "C++",
"members": [],
"name": "Get",
"notes": [],
Expand All @@ -347,14 +347,14 @@
"doc": "Factory handle",
"name": "factory",
"types": [
"dmResource::HFactory"
"HResourceFactory"
]
},
{
"doc": "Resource name",
"name": "name",
"types": [
"dmhash_t"
"const char*"
]
},
{
Expand All @@ -371,7 +371,7 @@
"doc": "RESULT_OK on success",
"name": "result",
"types": [
"dmResource::Result"
"ResourceResult"
]
}
],
Expand Down Expand Up @@ -735,21 +735,21 @@
"description": "Hint the preloader what to load before Create is called on the resource.\nThe resources are not guaranteed to be loaded before Create is called.\nThis function can be called from a worker thread.",
"error": "",
"examples": "",
"language": "C++",
"language": "",
"members": [],
"name": "PreloadHint",
"notes": [],
"parameters": [
{
"doc": "Preloader handle",
"name": "preloader",
"name": "factory",
"types": [
"dmResource::HResourcePreloadHintInfo"
]
},
{
"doc": "Resource path",
"name": "path",
"doc": "Resource name",
"name": "name",
"types": [
"const char*"
]
Expand All @@ -773,21 +773,21 @@
"description": "Hint the preloader what to load before Create is called on the resource.\nThe resources are not guaranteed to be loaded before Create is called.\nThis function can be called from a worker thread.",
"error": "",
"examples": "",
"language": "",
"language": "C++",
"members": [],
"name": "PreloadHint",
"notes": [],
"parameters": [
{
"doc": "Preloader handle",
"name": "factory",
"name": "preloader",
"types": [
"dmResource::HResourcePreloadHintInfo"
]
},
{
"doc": "Resource name",
"name": "name",
"doc": "Resource path",
"name": "path",
"types": [
"const char*"
]
Expand Down Expand Up @@ -851,18 +851,16 @@
"description": "Release resource",
"error": "",
"examples": "",
"language": "C++",
"language": "",
"members": [],
"name": "Release",
"notes": [
"Decreases ref count by 1. If it reaches 0, the resource destroy function is called."
],
"notes": [],
"parameters": [
{
"doc": "Factory handle",
"name": "factory",
"types": [
"HResourceFactory"
"dmResource::HFactory"
]
},
{
Expand All @@ -883,16 +881,18 @@
"description": "Release resource",
"error": "",
"examples": "",
"language": "",
"language": "C++",
"members": [],
"name": "Release",
"notes": [],
"notes": [
"Decreases ref count by 1. If it reaches 0, the resource destroy function is called."
],
"parameters": [
{
"doc": "Factory handle",
"name": "factory",
"types": [
"dmResource::HFactory"
"HResourceFactory"
]
},
{
Expand All @@ -913,7 +913,7 @@
"description": "Removes a previously registered file from the resource system",
"error": "",
"examples": "",
"language": "C++",
"language": "",
"members": [],
"name": "RemoveFile",
"notes": [],
Expand All @@ -922,7 +922,7 @@
"doc": "Factory handle",
"name": "factory",
"types": [
"HResourceFactory"
"dmResource::HFactory"
]
},
{
Expand All @@ -936,10 +936,10 @@
"replaces": "",
"returnvalues": [
{
"doc": "RESULT_OK on success",
"name": "result",
"doc": "on success.",
"name": "RESULT_OK",
"types": [
"ResourceResult"
"dmResource::Result"
]
}
],
Expand All @@ -951,7 +951,7 @@
"description": "Removes a previously registered file from the resource system",
"error": "",
"examples": "",
"language": "",
"language": "C++",
"members": [],
"name": "RemoveFile",
"notes": [],
Expand All @@ -960,7 +960,7 @@
"doc": "Factory handle",
"name": "factory",
"types": [
"dmResource::HFactory"
"HResourceFactory"
]
},
{
Expand All @@ -974,10 +974,10 @@
"replaces": "",
"returnvalues": [
{
"doc": "on success.",
"name": "RESULT_OK",
"doc": "RESULT_OK on success",
"name": "result",
"types": [
"dmResource::Result"
"ResourceResult"
]
}
],
Expand Down Expand Up @@ -1747,12 +1747,12 @@
"info": {
"brief": "Resource",
"description": "Functions for managing resource types.",
"file": "dmsdk/resource/resource.hpp",
"file": "dmsdk/resource/resource_gen.hpp",
"group": "DEFOLD SDK",
"language": "",
"language": "C++",
"name": "Resource",
"namespace": "dmResource",
"notes": [],
"path": "engine/resource/src/dmsdk/resource/resource.hpp"
"path": "engine/resource/src/dmsdk/resource/resource_gen.hpp"
}
}
Loading

0 comments on commit 922d40b

Please sign in to comment.