godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11405 from Ivorforce/godot-cpp-example-sconstruct

Browse Source 
Update `SConstruct` and `.gdextension` file of the godot-cpp example with newest conventions
This commit is contained in:
Max Hilbrunner
2025-11-06 06:33:05 +01:00
committed by GitHub
parent 1de8ca3c9c c46a399eab
commit f41537b8dd
2 changed files with 34 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
tutorials/scripting/cpp/files/cpp_example/SConstruct
View File

@@ -2,42 +2,31 @@
import os import os
import sys import sys
# You can find documentation for SCons and SConstruct files at:
# https://scons.org/documentation.html
# This lets SCons know that we're using godot-cpp, from the godot-cpp folder.
env = SConscript("godot-cpp/SConstruct") env = SConscript("godot-cpp/SConstruct")
# For reference: # Configures the 'src' directory as a source for header files.
# - CCFLAGS are compilation flags shared between C and C++
# - CFLAGS are for C-specific compilation flags
# - CXXFLAGS are for C++-specific compilation flags
# - CPPFLAGS are for pre-processor flags
# - CPPDEFINES are for pre-processor defines
# - LINKFLAGS are for linking flags
# tweak this if you want to use different folders, or more folders, to store your source code in.
env.Append(CPPPATH=["src/"]) env.Append(CPPPATH=["src/"])
# Collects all .cpp files in the 'src' folder as compile targets.
sources = Glob("src/*.cpp") sources = Glob("src/*.cpp")
if env["platform"] == "macos": # The filename for the dynamic library for this GDExtension.
library = env.SharedLibrary( # $SHLIBPREFIX is a platform specific prefix for the dynamic library ('lib' on Unix, '' on Windows).
"demo/bin/libgdexample.{}.{}.framework/libgdexample.{}.{}".format( # $SHLIBSUFFIX is the platform specific suffix for the dynamic library (for example '.dll' on Windows).
env["platform"], env["target"], env["platform"], env["target"] # env["suffix"] includes the build's feature tags (e.g. '.windows.template_debug.x86_64')
), # (see https://docs.godotengine.org/en/stable/tutorials/export/feature_tags.html).
source=sources, # The final path should match a path in the '.gdextension' file.
) lib_filename = "{}gdexample{}{}".format(env.subst('$SHLIBPREFIX'), env["suffix"], env.subst('$SHLIBSUFFIX'))
elif env["platform"] == "ios":
if env["ios_simulator"]:
library = env.StaticLibrary(
"demo/bin/libgdexample.{}.{}.simulator.a".format(env["platform"], env["target"]),
source=sources,
)
else:
library = env.StaticLibrary(
"demo/bin/libgdexample.{}.{}.a".format(env["platform"], env["target"]),
source=sources,
)
else:
library = env.SharedLibrary(
"demo/bin/libgdexample{}{}".format(env["suffix"], env["SHLIBSUFFIX"]),
source=sources,
)
# Creates a SCons target for the path with our sources.
library = env.SharedLibrary(
"demo/bin/{}".format(lib_filename),
source=sources,
)
# Selects the shared library as the default target.
Default(library) Default(library)

29
tutorials/scripting/cpp/gdextension_cpp_example.rst
View File

@@ -338,18 +338,18 @@ loaded for each platform and the entry function for the module. It is called ``g
[libraries] [libraries]
macos.debug = "./bin/libgdexample.macos.template_debug.dylib" macos.debug = "./libgdexample.macos.template_debug.dylib"
macos.release = "./bin/libgdexample.macos.template_release.dylib" macos.release = "./libgdexample.macos.template_release.dylib"
windows.debug.x86_32 = "./bin/libgdexample.windows.template_debug.x86_32.dll" windows.debug.x86_32 = "./gdexample.windows.template_debug.x86_32.dll"
windows.release.x86_32 = "./bin/libgdexample.windows.template_release.x86_32.dll" windows.release.x86_32 = "./gdexample.windows.template_release.x86_32.dll"
windows.debug.x86_64 = "./bin/libgdexample.windows.template_debug.x86_64.dll" windows.debug.x86_64 = "./gdexample.windows.template_debug.x86_64.dll"
windows.release.x86_64 = "./bin/libgdexample.windows.template_release.x86_64.dll" windows.release.x86_64 = "./gdexample.windows.template_release.x86_64.dll"
linux.debug.x86_64 = "./bin/libgdexample.linux.template_debug.x86_64.so" linux.debug.x86_64 = "./libgdexample.linux.template_debug.x86_64.so"
linux.release.x86_64 = "./bin/libgdexample.linux.template_release.x86_64.so" linux.release.x86_64 = "./libgdexample.linux.template_release.x86_64.so"
linux.debug.arm64 = "./bin/libgdexample.linux.template_debug.arm64.so" linux.debug.arm64 = "./libgdexample.linux.template_debug.arm64.so"
linux.release.arm64 = "./bin/libgdexample.linux.template_release.arm64.so" linux.release.arm64 = "./libgdexample.linux.template_release.arm64.so"
linux.debug.rv64 = "./bin/libgdexample.linux.template_debug.rv64.so" linux.debug.rv64 = "./libgdexample.linux.template_debug.rv64.so"
linux.release.rv64 = "./bin/libgdexample.linux.template_release.rv64.so" linux.release.rv64 = "./libgdexample.linux.template_release.rv64.so"
This file contains a ``configuration`` section that controls the entry function of the module. This file contains a ``configuration`` section that controls the entry function of the module.
You should also set the minimum compatible Godot version with ``compatibility_minimum``, You should also set the minimum compatible Godot version with ``compatibility_minimum``,
@@ -363,10 +363,7 @@ also result in *just* that file being exported when you export the project,
which means the data pack won't contain libraries that are incompatible with the which means the data pack won't contain libraries that are incompatible with the
target platform. target platform.
Finally, the ``dependencies`` section allows you to name additional dynamic You can learn more about ``.gdextension`` files at :ref:`doc_gdextension_file`.
libraries that should be included as well. This is important when your GDExtension
plugin implements someone else's library and requires you to supply a
third-party dynamic library with your project.
Here is another overview to check the correct file structure: Here is another overview to check the correct file structure: