Rendering Engine 0.2.17
Modular Graphics Rendering Engine | v0.2.17
Loading...
Searching...
No Matches
Functions | Variables
package_sdk Namespace Reference

Functions

 read_version ()
 
 detect_platform ()
 
 copy_tree (src, dst, ignore=None)
 
 ensure_dir (path)
 
 write_manifest (path, version, platform)
 
 main ()
 

Variables

 REPO_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), "../../"))
 
 BUILD_ROOT = os.path.join(REPO_ROOT, "Build")
 
 INSTALL_ROOT = os.path.join(BUILD_ROOT, "Installed")
 
 PACKAGE_ROOT = os.path.join(BUILD_ROOT, "Packages")
 
 SDK_TEMP_ROOT = os.path.join(BUILD_ROOT, "SDK")
 
 LOGS_ROOT = os.path.join(BUILD_ROOT, "Logs")
 
 VERSION_HEADER
 
list DOC_FILES
 

Function Documentation

◆ copy_tree()

package_sdk.copy_tree (   src,
  dst,
  ignore = None 
)

Definition at line 105 of file package_sdk.py.

105def copy_tree(src, dst, ignore=None):
106 if not os.path.exists(src):
107 logging.warning(f"Source path does not exist, skipping: {src}")
108 return
109 if os.path.exists(dst):
110 shutil.rmtree(dst)
111 shutil.copytree(src, dst, ignore=ignore)
112 logging.info(f"Copied tree: {src} -> {dst}")
113
114

◆ detect_platform()

package_sdk.detect_platform ( ) 
Return a human-readable platform string.

Definition at line 93 of file package_sdk.py.

93def detect_platform():
94 """Return a human-readable platform string."""
95 p = sys.platform
96 if p.startswith("win"):
97 return "Windows"
98 elif p.startswith("linux"):
99 return "Linux"
100 elif p.startswith("freebsd"):
101 return "FreeBSD"
102 return "Unknown"
103
104

◆ ensure_dir()

package_sdk.ensure_dir (   path)

Definition at line 115 of file package_sdk.py.

115def ensure_dir(path):
116 os.makedirs(path, exist_ok=True)
117 return path
118
119

◆ main()

package_sdk.main ( )

Definition at line 142 of file package_sdk.py.

142def main():
143 # Init logging
144 ensure_dir(LOGS_ROOT)
145 logging.basicConfig(
146 filename=os.path.join(LOGS_ROOT, "packaging.log"),
147 level=logging.INFO,
148 format="%(asctime)s %(levelname)s: %(message)s",
149 )
150 logging.info("=== SDK Packaging Started ===")
151
152 try:
153 version = read_version()
154 platform = detect_platform()
155
156 sdk_name = f"RenderingEngine-v{version}-SDK-{platform}"
157 sdk_root = os.path.join(SDK_TEMP_ROOT, sdk_name)
158
159 # Clean previous SDK for this version/platform
160 if os.path.exists(sdk_root):
161 shutil.rmtree(sdk_root)
162 ensure_dir(sdk_root)
163
164 logging.info(f"Version : {version}")
165 logging.info(f"Platform: {platform}")
166 logging.info(f"SDK root: {sdk_root}")
167
168 # Paths inside SDK
169 sdk_rendering_engine_root = ensure_dir(os.path.join(sdk_root, "RenderingEngine"))
170 sdk_render_lib_root = ensure_dir(os.path.join(sdk_rendering_engine_root, "RenderingLibrary"))
171 sdk_material_compiler_root = ensure_dir(os.path.join(sdk_rendering_engine_root, "MaterialCompiler"))
172 sdk_scripts_root = ensure_dir(os.path.join(sdk_rendering_engine_root, "Scripts"))
173
174 # --------------------------------------------------------------
175 # 1. RenderingLibrary: headers + libs + cmake files
176 # --------------------------------------------------------------
177 installed_engine_root = os.path.join(INSTALL_ROOT, "RenderingEngine")
178
179 # RenderingLibrary
180 installed_render_lib = os.path.join(installed_engine_root, "RenderingLibrary")
181
182 for required_dir in ("Include", "Library"):
183 required_path = os.path.join(installed_render_lib, required_dir)
184
185 if not os.path.isdir(required_path):
186 raise FileNotFoundError(
187 f"Required SDK component not found: {required_path}"
188 )
189
190 copy_tree(
191 os.path.join(installed_render_lib, "Include"),
192 os.path.join(sdk_render_lib_root, "Include"),
193 )
194
195 copy_tree(
196 os.path.join(installed_render_lib, "Library"),
197 os.path.join(sdk_render_lib_root, "Library"),
198 )
199
200 # --------------------------------------------------------------
201 # 2. MaterialCompiler (tool + its local DLL)
202 # --------------------------------------------------------------
203 installed_mc_root = os.path.join(installed_engine_root, "MaterialCompiler")
204 copy_tree(installed_mc_root, sdk_material_compiler_root)
205
206 # --------------------------------------------------------------
207 # 3. External vendored headers (glm, json, vulkan,...)
208 # --------------------------------------------------------------
209 installed_external_root = os.path.join(installed_engine_root, "External")
210 copy_tree(installed_external_root, os.path.join(sdk_rendering_engine_root, "External"))
211
212 # --------------------------------------------------------------
213 # 4. Project management scripts and templates
214 # --------------------------------------------------------------
215
216 copy_tree(
217 os.path.join(REPO_ROOT, "RenderingEngine", "Scripts", "Templates"),
218 os.path.join(sdk_scripts_root, "Templates"),
219 )
220
221 project_scripts = [
222 "create_project.py",
223 "register_project.py",
224 ]
225
226 for script_name in project_scripts:
227 script_src = os.path.join(
228 REPO_ROOT,
229 "RenderingEngine",
230 "Scripts",
231 script_name,
232 )
233
234 if os.path.isfile(script_src):
235 shutil.copy2(
236 script_src,
237 os.path.join(sdk_scripts_root, script_name),
238 )
239 logging.info(f"Copied script: {script_name}")
240 else:
241 raise FileNotFoundError(
242 f"Required SDK script not found: {script_src}"
243 )
244
245
246 # --------------------------------------------------------------
247 # 5. Documentation
248 # --------------------------------------------------------------
249 doc_dst = ensure_dir(os.path.join(sdk_root, "Doc"))
250 for doc in DOC_FILES:
251 src = os.path.join(REPO_ROOT, doc)
252 if os.path.isfile(src):
253 shutil.copy2(src, doc_dst)
254 logging.info(f"Copied documentation: {src}")
255 else:
256 logging.warning(f"Documentation file missing, skipped: {src}")
257
258 # --------------------------------------------------------------
259 # 6. Content Examples (copied directly from root-level folder)
260 # --------------------------------------------------------------
261 examples_src_root = os.path.join(REPO_ROOT, "ContentExamples")
262 examples_dst_root = ensure_dir(os.path.join(sdk_root, "ContentExamples"))
263
264 def ignore_example(dirpath, names):
265 ignore = []
266 for n in names:
267 if n in ("Build", "Intermediate", "Local", ".vs", ".vscode", "x64"):
268 ignore.append(n)
269 elif n.endswith(".user") or n.endswith(".vcxproj") or n.endswith(".vcxproj.filters"):
270 ignore.append(n)
271 return ignore
272
273 if os.path.isdir(examples_src_root):
274 copy_tree(
275 examples_src_root,
276 examples_dst_root,
277 ignore=ignore_example,
278 )
279 logging.info("Copied ContentExamples folder.")
280 else:
281 logging.warning("No ContentExamples folder found.")
282
283 # --------------------------------------------------------------
284 # 7. UserApplications (empty placeholder)
285 # --------------------------------------------------------------
286 ensure_dir(os.path.join(sdk_root, "UserApplications"))
287
288 # --------------------------------------------------------------
289 # 7. Manifest
290 # --------------------------------------------------------------
291 write_manifest(os.path.join(sdk_root, "Manifest.txt"), version, platform)
292
293 # --------------------------------------------------------------
294 # 8. Create Archive
295 # --------------------------------------------------------------
296 ensure_dir(PACKAGE_ROOT)
297 archive_path = os.path.join(PACKAGE_ROOT, sdk_name)
298
299 # Clean old archive if exists
300 for ext in (".tar.gz", ".zip", ".tgz"):
301 old = archive_path + ext
302 if os.path.exists(old):
303 os.remove(old)
304
305 shutil.make_archive(
306 archive_path,
307 "gztar",
308 root_dir=SDK_TEMP_ROOT,
309 base_dir=sdk_name,
310 )
311 logging.info(f"Archive created: {archive_path}.tar.gz")
312 logging.info("=== SDK Packaging Complete ===")
313
314 except Exception as e:
315 logging.error(f"SDK packaging failed: {e}", exc_info=True)
316 print(f"SDK packaging failed: {e}")
317 sys.exit(1)
318
319
main
int main(int argc, char *argv[])
Definition MaterialCompiler/Source/main.cpp:17

◆ read_version()

package_sdk.read_version ( ) 
Parse version.h and extract MAJOR.MINOR.PATCH as a string.

Definition at line 72 of file package_sdk.py.

72def read_version():
73 """Parse version.h and extract MAJOR.MINOR.PATCH as a string."""
74 if not os.path.isfile(VERSION_HEADER):
75 raise RuntimeError(f"version.h not found at: {VERSION_HEADER}")
76
77 with open(VERSION_HEADER, "r", encoding="utf-8") as f:
78 text = f.read()
79
80 major = re.search(r"#define\s+RENDERING_ENGINE_VERSION_MAJOR\s+(\d+)", text)
81 minor = re.search(r"#define\s+RENDERING_ENGINE_VERSION_MINOR\s+(\d+)", text)
82 patch = re.search(r"#define\s+RENDERING_ENGINE_VERSION_PATCH\s+(\d+)", text)
83
84 if not (major and minor and patch):
85 raise RuntimeError(
86 "version.h missing required version macros "
87 "(RENDERING_ENGINE_VERSION_MAJOR/MINOR/PATCH)."
88 )
89
90 return f"{major.group(1)}.{minor.group(1)}.{patch.group(1)}"
91
92

◆ write_manifest()

package_sdk.write_manifest (   path,
  version,
  platform 
)

Definition at line 120 of file package_sdk.py.

120def write_manifest(path, version, platform):
121 with open(path, "w", encoding="utf-8") as f:
122 f.write("Rendering Engine SDK Manifest\n")
123 f.write("=====================================\n\n")
124 f.write(f"Version : {version}\n")
125 f.write(f"Platform: {platform}\n")
126 f.write(f"Date : {datetime.datetime.now()}\n\n")
127 f.write("Layout:\n")
128 f.write("- RenderingEngine/RenderingLibrary : core engine library + headers + cmake files\n")
129 f.write("- RenderingEngine/MaterialCompiler : material compiler tool + local engine DLL\n")
130 f.write("- RenderingEngine/Scripts : project generation scripts + templates\n")
131 f.write("- ContentExamples/ : sample projects\n")
132 f.write("- UserApplications/ : place for user-created apps\n")
133 f.write("- Doc/ : documentation\n")
134 logging.info(f"Manifest written: {path}")
135
136
137# --------------------------------------------------------------------
138# Main Packaging Logic
139# --------------------------------------------------------------------
140
141

Variable Documentation

◆ BUILD_ROOT

package_sdk.BUILD_ROOT = os.path.join(REPO_ROOT, "Build")

Definition at line 41 of file package_sdk.py.

◆ DOC_FILES

list package_sdk.DOC_FILES
Initial value:
1= [
2 "README.md",
3 "Doc/app_config_guide.md",
4 "Doc/application_development_guide.md",
5 "Doc/ci_cd_guide.md",
6 "Doc/debugging_guide.md",
7 "Doc/developer_guide.md",
8 "Doc/docker_container.md",
9 "Doc/getting_started.md",
10 "Doc/performance_profiling_guide.md",
11 "Doc/prepare_environment.md",
12 "Doc/project_creation_guide.md",
13 "Doc/project_packaging_guide.md",
14 "Doc/sdk_packaging_guide.md",
15]

Definition at line 51 of file package_sdk.py.

◆ INSTALL_ROOT

package_sdk.INSTALL_ROOT = os.path.join(BUILD_ROOT, "Installed")

Definition at line 42 of file package_sdk.py.

◆ LOGS_ROOT

package_sdk.LOGS_ROOT = os.path.join(BUILD_ROOT, "Logs")

Definition at line 45 of file package_sdk.py.

◆ PACKAGE_ROOT

package_sdk.PACKAGE_ROOT = os.path.join(BUILD_ROOT, "Packages")

Definition at line 43 of file package_sdk.py.

◆ REPO_ROOT

package_sdk.REPO_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), "../../"))

Definition at line 40 of file package_sdk.py.

◆ SDK_TEMP_ROOT

package_sdk.SDK_TEMP_ROOT = os.path.join(BUILD_ROOT, "SDK")

Definition at line 44 of file package_sdk.py.

◆ VERSION_HEADER

package_sdk.VERSION_HEADER
Initial value:
1= os.path.join(
2 BUILD_ROOT, "Intermediate", "Generated", "version.h"
3)

Definition at line 47 of file package_sdk.py.