Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| c8465bb335 | |||
| 689d5e979d |
+288
@@ -0,0 +1,288 @@
|
||||
---
|
||||
Language: Cpp
|
||||
AccessModifierOffset: 0
|
||||
AlignAfterOpenBracket: DontAlign
|
||||
AlignArrayOfStructures: None
|
||||
AlignConsecutiveAssignments:
|
||||
Enabled: false
|
||||
AcrossEmptyLines: false
|
||||
AcrossComments: false
|
||||
AlignCompound: false
|
||||
AlignFunctionDeclarations: false
|
||||
AlignFunctionPointers: false
|
||||
PadOperators: true
|
||||
AlignConsecutiveBitFields:
|
||||
Enabled: false
|
||||
AcrossEmptyLines: false
|
||||
AcrossComments: false
|
||||
AlignCompound: false
|
||||
AlignFunctionDeclarations: false
|
||||
AlignFunctionPointers: false
|
||||
PadOperators: false
|
||||
AlignConsecutiveDeclarations:
|
||||
Enabled: false
|
||||
AcrossEmptyLines: false
|
||||
AcrossComments: false
|
||||
AlignCompound: false
|
||||
AlignFunctionDeclarations: true
|
||||
AlignFunctionPointers: false
|
||||
PadOperators: false
|
||||
AlignConsecutiveMacros:
|
||||
Enabled: false
|
||||
AcrossEmptyLines: false
|
||||
AcrossComments: false
|
||||
AlignCompound: false
|
||||
AlignFunctionDeclarations: false
|
||||
AlignFunctionPointers: false
|
||||
PadOperators: false
|
||||
AlignConsecutiveShortCaseStatements:
|
||||
Enabled: false
|
||||
AcrossEmptyLines: false
|
||||
AcrossComments: false
|
||||
AlignCaseArrows: false
|
||||
AlignCaseColons: false
|
||||
AlignConsecutiveTableGenBreakingDAGArgColons:
|
||||
Enabled: false
|
||||
AcrossEmptyLines: false
|
||||
AcrossComments: false
|
||||
AlignCompound: false
|
||||
AlignFunctionDeclarations: false
|
||||
AlignFunctionPointers: false
|
||||
PadOperators: false
|
||||
AlignConsecutiveTableGenCondOperatorColons:
|
||||
Enabled: false
|
||||
AcrossEmptyLines: false
|
||||
AcrossComments: false
|
||||
AlignCompound: false
|
||||
AlignFunctionDeclarations: false
|
||||
AlignFunctionPointers: false
|
||||
PadOperators: false
|
||||
AlignConsecutiveTableGenDefinitionColons:
|
||||
Enabled: false
|
||||
AcrossEmptyLines: false
|
||||
AcrossComments: false
|
||||
AlignCompound: false
|
||||
AlignFunctionDeclarations: false
|
||||
AlignFunctionPointers: false
|
||||
PadOperators: false
|
||||
AlignEscapedNewlines: Right
|
||||
AlignOperands: DontAlign
|
||||
AlignTrailingComments:
|
||||
Kind: Never
|
||||
OverEmptyLines: 0
|
||||
AllowAllArgumentsOnNextLine: true
|
||||
AllowAllParametersOfDeclarationOnNextLine: true
|
||||
AllowBreakBeforeNoexceptSpecifier: Never
|
||||
AllowShortBlocksOnASingleLine: Empty
|
||||
AllowShortCaseExpressionOnASingleLine: true
|
||||
AllowShortCaseLabelsOnASingleLine: false
|
||||
AllowShortCompoundRequirementOnASingleLine: true
|
||||
AllowShortEnumsOnASingleLine: true
|
||||
AllowShortFunctionsOnASingleLine: All
|
||||
AllowShortIfStatementsOnASingleLine: Never
|
||||
AllowShortLambdasOnASingleLine: All
|
||||
AllowShortLoopsOnASingleLine: false
|
||||
AllowShortNamespacesOnASingleLine: false
|
||||
AlwaysBreakAfterDefinitionReturnType: None
|
||||
AlwaysBreakBeforeMultilineStrings: false
|
||||
AttributeMacros:
|
||||
- __capability
|
||||
BinPackArguments: true
|
||||
BinPackParameters: BinPack
|
||||
BitFieldColonSpacing: Both
|
||||
BraceWrapping:
|
||||
AfterCaseLabel: false
|
||||
AfterClass: false
|
||||
AfterControlStatement: Never
|
||||
AfterEnum: false
|
||||
AfterExternBlock: false
|
||||
AfterFunction: true
|
||||
AfterNamespace: false
|
||||
AfterObjCDeclaration: false
|
||||
AfterStruct: false
|
||||
AfterUnion: false
|
||||
BeforeCatch: false
|
||||
BeforeElse: false
|
||||
BeforeLambdaBody: false
|
||||
BeforeWhile: false
|
||||
IndentBraces: false
|
||||
SplitEmptyFunction: true
|
||||
SplitEmptyRecord: true
|
||||
SplitEmptyNamespace: true
|
||||
BreakAdjacentStringLiterals: true
|
||||
BreakAfterAttributes: Leave
|
||||
BreakAfterJavaFieldAnnotations: false
|
||||
BreakAfterReturnType: None
|
||||
BreakArrays: true
|
||||
BreakBeforeBinaryOperators: All
|
||||
BreakBeforeConceptDeclarations: Always
|
||||
BreakBeforeBraces: Attach
|
||||
BreakBeforeInlineASMColon: OnlyMultiline
|
||||
BreakBeforeTernaryOperators: true
|
||||
BreakBinaryOperations: Never
|
||||
BreakConstructorInitializers: BeforeComma
|
||||
BreakFunctionDefinitionParameters: false
|
||||
BreakInheritanceList: BeforeColon
|
||||
BreakStringLiterals: true
|
||||
BreakTemplateDeclarations: MultiLine
|
||||
ColumnLimit: 120
|
||||
CommentPragmas: '^ IWYU pragma:'
|
||||
CompactNamespaces: false
|
||||
ConstructorInitializerIndentWidth: 2
|
||||
ContinuationIndentWidth: 2
|
||||
Cpp11BracedListStyle: false
|
||||
DerivePointerAlignment: false
|
||||
DisableFormat: false
|
||||
EmptyLineAfterAccessModifier: Never
|
||||
EmptyLineBeforeAccessModifier: LogicalBlock
|
||||
ExperimentalAutoDetectBinPacking: false
|
||||
FixNamespaceComments: false
|
||||
ForEachMacros:
|
||||
- foreach
|
||||
- Q_FOREACH
|
||||
- BOOST_FOREACH
|
||||
IfMacros:
|
||||
- KJ_IF_MAYBE
|
||||
IncludeBlocks: Preserve
|
||||
IncludeCategories:
|
||||
- Regex: '^"(llvm|llvm-c|clang|clang-c)/'
|
||||
Priority: 2
|
||||
SortPriority: 0
|
||||
CaseSensitive: false
|
||||
- Regex: '^(<|"(gtest|gmock|isl|json)/)'
|
||||
Priority: 3
|
||||
SortPriority: 0
|
||||
CaseSensitive: false
|
||||
- Regex: '.*'
|
||||
Priority: 1
|
||||
SortPriority: 0
|
||||
CaseSensitive: false
|
||||
IncludeIsMainRegex: '(Test)?$'
|
||||
IncludeIsMainSourceRegex: ''
|
||||
IndentAccessModifiers: true
|
||||
IndentCaseBlocks: false
|
||||
IndentCaseLabels: false
|
||||
IndentExportBlock: true
|
||||
IndentExternBlock: AfterExternBlock
|
||||
IndentGotoLabels: true
|
||||
IndentPPDirectives: None
|
||||
IndentRequiresClause: true
|
||||
IndentWidth: 2
|
||||
IndentWrappedFunctionNames: false
|
||||
InsertBraces: false
|
||||
InsertNewlineAtEOF: false
|
||||
InsertTrailingCommas: None
|
||||
IntegerLiteralSeparator:
|
||||
Binary: 0
|
||||
BinaryMinDigits: 0
|
||||
Decimal: 0
|
||||
DecimalMinDigits: 0
|
||||
Hex: 0
|
||||
HexMinDigits: 0
|
||||
JavaScriptQuotes: Leave
|
||||
JavaScriptWrapImports: true
|
||||
KeepEmptyLines:
|
||||
AtEndOfFile: false
|
||||
AtStartOfBlock: true
|
||||
AtStartOfFile: true
|
||||
KeepFormFeed: false
|
||||
LambdaBodyIndentation: Signature
|
||||
LineEnding: DeriveLF
|
||||
MacroBlockBegin: ''
|
||||
MacroBlockEnd: ''
|
||||
MainIncludeChar: Quote
|
||||
MaxEmptyLinesToKeep: 1
|
||||
NamespaceIndentation: All
|
||||
ObjCBinPackProtocolList: Auto
|
||||
ObjCBlockIndentWidth: 4
|
||||
ObjCBreakBeforeNestedBlockParam: true
|
||||
ObjCSpaceAfterProperty: true
|
||||
ObjCSpaceBeforeProtocolList: true
|
||||
PackConstructorInitializers: BinPack
|
||||
PenaltyBreakAssignment: 2
|
||||
PenaltyBreakBeforeFirstCallParameter: 19
|
||||
PenaltyBreakBeforeMemberAccess: 150
|
||||
PenaltyBreakComment: 300
|
||||
PenaltyBreakFirstLessLess: 120
|
||||
PenaltyBreakOpenParenthesis: 0
|
||||
PenaltyBreakScopeResolution: 500
|
||||
PenaltyBreakString: 1000
|
||||
PenaltyBreakTemplateDeclaration: 10
|
||||
PenaltyExcessCharacter: 1000000
|
||||
PenaltyIndentedWhitespace: 0
|
||||
PenaltyReturnTypeOnItsOwnLine: 60
|
||||
PointerAlignment: Left
|
||||
PPIndentWidth: -1
|
||||
QualifierAlignment: Leave
|
||||
ReferenceAlignment: Pointer
|
||||
ReflowComments: Always
|
||||
RemoveBracesLLVM: false
|
||||
RemoveEmptyLinesInUnwrappedLines: false
|
||||
RemoveParentheses: Leave
|
||||
RemoveSemicolon: false
|
||||
RequiresClausePosition: OwnLine
|
||||
RequiresExpressionIndentation: OuterScope
|
||||
SeparateDefinitionBlocks: Leave
|
||||
ShortNamespaceLines: 1
|
||||
SkipMacroDefinitionBody: false
|
||||
SortIncludes: CaseSensitive
|
||||
SortJavaStaticImport: Before
|
||||
SortUsingDeclarations: LexicographicNumeric
|
||||
SpaceAfterCStyleCast: false
|
||||
SpaceAfterLogicalNot: false
|
||||
SpaceAfterTemplateKeyword: true
|
||||
SpaceAroundPointerQualifiers: Default
|
||||
SpaceBeforeAssignmentOperators: true
|
||||
SpaceBeforeCaseColon: false
|
||||
SpaceBeforeCpp11BracedList: true
|
||||
SpaceBeforeCtorInitializerColon: true
|
||||
SpaceBeforeInheritanceColon: true
|
||||
SpaceBeforeJsonColon: false
|
||||
SpaceBeforeParens: ControlStatements
|
||||
SpaceBeforeParensOptions:
|
||||
AfterControlStatements: true
|
||||
AfterForeachMacros: true
|
||||
AfterFunctionDefinitionName: false
|
||||
AfterFunctionDeclarationName: false
|
||||
AfterIfMacros: true
|
||||
AfterOverloadedOperator: false
|
||||
AfterPlacementOperator: true
|
||||
AfterRequiresInClause: false
|
||||
AfterRequiresInExpression: false
|
||||
BeforeNonEmptyParentheses: false
|
||||
SpaceBeforeRangeBasedForLoopColon: true
|
||||
SpaceBeforeSquareBrackets: false
|
||||
SpaceInEmptyBlock: true
|
||||
SpacesBeforeTrailingComments: 1
|
||||
SpacesInAngles: Never
|
||||
SpacesInContainerLiterals: true
|
||||
SpacesInLineCommentPrefix:
|
||||
Minimum: 1
|
||||
Maximum: -1
|
||||
SpacesInParens: Never
|
||||
SpacesInParensOptions:
|
||||
ExceptDoubleParentheses: false
|
||||
InCStyleCasts: false
|
||||
InConditionalStatements: false
|
||||
InEmptyParentheses: false
|
||||
Other: false
|
||||
SpacesInSquareBrackets: false
|
||||
Standard: Latest
|
||||
StatementAttributeLikeMacros:
|
||||
- Q_EMIT
|
||||
StatementMacros:
|
||||
- Q_UNUSED
|
||||
- QT_REQUIRE_VERSION
|
||||
TableGenBreakInsideDAGArg: DontBreak
|
||||
TabWidth: 8
|
||||
UseTab: Never
|
||||
VerilogBreakBetweenInstancePorts: true
|
||||
WhitespaceSensitiveMacros:
|
||||
- BOOST_PP_STRINGIZE
|
||||
- CF_SWIFT_NAME
|
||||
- NS_SWIFT_NAME
|
||||
- PP_STRINGIZE
|
||||
- STRINGIZE
|
||||
WrapNamespaceBodyWithEmptyLines: Leave
|
||||
...
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
build/
|
||||
imgui.ini
|
||||
.vscode/
|
||||
+105
-21
@@ -10,41 +10,101 @@ project(hdk-sdl
|
||||
# This is a header-only library; src/ files are not compiled into any targets.
|
||||
|
||||
# hdk-sdl OPTIONS
|
||||
option(HDK_SDL_TESTS "Build hdk-sdl tests" ${HDK_TESTS})
|
||||
option(HDK_SDL_EXAMPLES "Build hdk-sdl examples" ${HDK_EXAMPLES})
|
||||
option(HDK_SDL_INSTALL_TARGETS "Enable hdk-sdl install/export stubs" ON)
|
||||
option(HDK_SDL_SYSTEM_SDL3 "Use system SDL3 instead of FetchContent for building" OFF)
|
||||
option(HDK_SDL_BUNDLE_SDL3 "Build and bundle SDL3 as a static lib with hdk-sdl install" OFF)
|
||||
option(HDK_TESTS "Build hdk-sdl tests" OFF)
|
||||
option(HDK_EXAMPLES "Build hdk-sdl examples" OFF)
|
||||
option(HDK_INSTALL_TARGETS "Enable hdk-sdl install/export stubs" ON)
|
||||
option(HDK_BUNDLE_SDL3 "Build and bundle SDL3 as a static lib with hdk-sdl install" OFF)
|
||||
|
||||
if(HDK_SDL_SYSTEM_SDL3 AND HDK_SDL_BUNDLE_SDL3)
|
||||
message(FATAL_ERROR "HDK_SDL_SYSTEM_SDL3 and HDK_SDL_BUNDLE_SDL3 are mutually exclusive")
|
||||
if(NOT DEFINED HDK_USE_SYSTEM_DEPS)
|
||||
set(HDK_USE_SYSTEM_DEPS ON)
|
||||
endif()
|
||||
|
||||
if(HDK_SDL_EXAMPLES)
|
||||
if(DEFINED HDK_CMAKE_POLICY_DIR AND EXISTS "${HDK_CMAKE_POLICY_DIR}/HDKDependencyPolicy.cmake")
|
||||
include("${HDK_CMAKE_POLICY_DIR}/HDKDependencyPolicy.cmake")
|
||||
elseif(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/../cmake/HDKDependencyPolicy.cmake")
|
||||
include("${CMAKE_CURRENT_SOURCE_DIR}/../cmake/HDKDependencyPolicy.cmake")
|
||||
elseif(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/cmake/HDKDependencyPolicy.cmake")
|
||||
include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/HDKDependencyPolicy.cmake")
|
||||
else()
|
||||
message(FATAL_ERROR "Unable to locate HDKDependencyPolicy.cmake")
|
||||
endif()
|
||||
|
||||
option(HDK_SYSTEM_SDL3 "Prefer system SDL3 before FetchContent fallback" ${HDK_USE_SYSTEM_DEPS})
|
||||
option(HDK_FETCH_SDL3_FALLBACK "Fetch SDL3 when a suitable system package is unavailable" ON)
|
||||
option(HDK_SYSTEM_HDK_GRID "Prefer system hdk-grid before FetchContent fallback" ${HDK_USE_SYSTEM_DEPS})
|
||||
option(HDK_FETCH_HDK_GRID_FALLBACK "Fetch hdk-grid when a suitable system package is unavailable" ON)
|
||||
|
||||
if(NOT DEFINED HDK_SDL3_MIN_VERSION)
|
||||
set(HDK_SDL3_MIN_VERSION "3.4.8")
|
||||
endif()
|
||||
|
||||
if(NOT DEFINED HDK_GRID_MIN_VERSION)
|
||||
set(HDK_GRID_MIN_VERSION "0.0.1")
|
||||
endif()
|
||||
|
||||
if(NOT DEFINED HDK_GRID_GIT_REPOSITORY)
|
||||
set(HDK_GRID_GIT_REPOSITORY "https://git.ufp.institute/ufp/hdk-grid.git")
|
||||
endif()
|
||||
|
||||
if(NOT DEFINED HDK_GRID_GIT_TAG)
|
||||
set(HDK_GRID_GIT_TAG "v${HDK_GRID_MIN_VERSION}")
|
||||
endif()
|
||||
|
||||
if(HDK_SYSTEM_SDL3 AND HDK_BUNDLE_SDL3)
|
||||
message(FATAL_ERROR "HDK_SYSTEM_SDL3 and HDK_BUNDLE_SDL3 are mutually exclusive")
|
||||
endif()
|
||||
|
||||
if(HDK_EXAMPLES)
|
||||
add_subdirectory(examples)
|
||||
endif()
|
||||
|
||||
hdk_resolve_dependency(
|
||||
NAME hdk-grid
|
||||
TARGETS hdk::hdk-grid hdk-grid
|
||||
PACKAGE_NAMES hdk-grid
|
||||
MIN_VERSION ${HDK_GRID_MIN_VERSION}
|
||||
USE_SYSTEM ${HDK_SYSTEM_HDK_GRID}
|
||||
FETCH_FALLBACK ${HDK_FETCH_HDK_GRID_FALLBACK}
|
||||
GIT_REPOSITORY ${HDK_GRID_GIT_REPOSITORY}
|
||||
GIT_TAG ${HDK_GRID_GIT_TAG}
|
||||
FETCHCONTENT_NAME hdk-grid
|
||||
)
|
||||
|
||||
if(TARGET hdk-grid AND NOT TARGET hdk::hdk-grid)
|
||||
add_library(hdk::hdk-grid ALIAS hdk-grid)
|
||||
endif()
|
||||
|
||||
# FOR SDL Building
|
||||
if(NOT HDK_SDL_SYSTEM_SDL3)
|
||||
set(_hdk_sdl_need_fetch_sdl3 ON)
|
||||
if(TARGET SDL3::SDL3)
|
||||
set(_hdk_sdl_need_fetch_sdl3 OFF)
|
||||
elseif(HDK_SYSTEM_SDL3)
|
||||
find_package(SDL3 ${HDK_SDL3_MIN_VERSION} QUIET CONFIG)
|
||||
if(SDL3_FOUND)
|
||||
set(_hdk_sdl_need_fetch_sdl3 OFF)
|
||||
elseif(NOT HDK_FETCH_SDL3_FALLBACK)
|
||||
message(FATAL_ERROR "SDL3 >= ${HDK_SDL3_MIN_VERSION} not found and HDK_FETCH_SDL3_FALLBACK=OFF")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
if(_hdk_sdl_need_fetch_sdl3)
|
||||
set(SDL_TEST OFF CACHE BOOL "Disable SDL tests" FORCE)
|
||||
set(SDL_EXAMPLES OFF CACHE BOOL "Disable SDL examples" FORCE)
|
||||
set(SDL_INSTALL OFF CACHE BOOL "Disable SDL install" FORCE)
|
||||
# NOTE: Possibly disable SDL_PIPEWIRE and/or SDL_PIPEWIRE_SHARED?
|
||||
|
||||
if(HDK_SDL_BUNDLE_SDL3)
|
||||
|
||||
if(HDK_BUNDLE_SDL3)
|
||||
set(SDL_STATIC ON CACHE BOOL "Build SDL3 as static library for bundling" FORCE)
|
||||
set(SDL_SHARED OFF CACHE BOOL "Disable SDL3 shared library for bundling" FORCE)
|
||||
endif()
|
||||
|
||||
|
||||
include(FetchContent)
|
||||
FetchContent_Declare(
|
||||
SDL3
|
||||
GIT_REPOSITORY https://github.com/libsdl-org/SDL.git
|
||||
GIT_TAG release-3.4.8
|
||||
GIT_TAG release-${HDK_SDL3_MIN_VERSION}
|
||||
)
|
||||
FetchContent_MakeAvailable(SDL3)
|
||||
else()
|
||||
find_package(SDL3 REQUIRED)
|
||||
endif()
|
||||
|
||||
include(GNUInstallDirs)
|
||||
@@ -52,7 +112,7 @@ include(GNUInstallDirs)
|
||||
add_library(hdk-sdl INTERFACE)
|
||||
target_link_libraries(hdk-sdl INTERFACE
|
||||
$<BUILD_INTERFACE:SDL3::SDL3>
|
||||
$<BUILD_INTERFACE:hdk-grid>
|
||||
$<BUILD_INTERFACE:hdk::hdk-grid>
|
||||
$<INSTALL_INTERFACE:SDL3::SDL3>
|
||||
$<INSTALL_INTERFACE:hdk::hdk-grid>
|
||||
)
|
||||
@@ -62,15 +122,16 @@ target_include_directories(hdk-sdl INTERFACE
|
||||
)
|
||||
target_compile_features(hdk-sdl INTERFACE cxx_std_17)
|
||||
|
||||
if(HDK_SDL_INSTALL_TARGETS)
|
||||
if(HDK_INSTALL_TARGETS)
|
||||
include(CMakePackageConfigHelpers)
|
||||
|
||||
install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/
|
||||
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
|
||||
COMPONENT hdk-sdl_dev
|
||||
)
|
||||
|
||||
# Choose config file based on bundle mode
|
||||
if(HDK_SDL_BUNDLE_SDL3)
|
||||
if(HDK_BUNDLE_SDL3)
|
||||
set(_hdk_sdl_config_file hdk-sdlConfig-bundled.cmake.in)
|
||||
else()
|
||||
set(_hdk_sdl_config_file hdk-sdlConfig.cmake.in)
|
||||
@@ -93,16 +154,19 @@ if(HDK_SDL_INSTALL_TARGETS)
|
||||
${CMAKE_CURRENT_BINARY_DIR}/hdk-sdlConfig.cmake
|
||||
${CMAKE_CURRENT_BINARY_DIR}/hdk-sdlConfigVersion.cmake
|
||||
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/hdk-sdl
|
||||
COMPONENT hdk-sdl_dev
|
||||
)
|
||||
|
||||
# Bundled SDL3 install rules
|
||||
if(HDK_SDL_BUNDLE_SDL3)
|
||||
if(HDK_BUNDLE_SDL3)
|
||||
install(FILES $<TARGET_FILE:SDL3-static>
|
||||
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/hdk-sdl/sdl3-static
|
||||
COMPONENT hdk-sdl_dev
|
||||
)
|
||||
|
||||
install(DIRECTORY ${sdl3_SOURCE_DIR}/include/
|
||||
install(DIRECTORY ${SDL3_SOURCE_DIR}/include/
|
||||
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
|
||||
COMPONENT hdk-sdl_dev
|
||||
)
|
||||
|
||||
configure_file(
|
||||
@@ -113,11 +177,31 @@ if(HDK_SDL_INSTALL_TARGETS)
|
||||
|
||||
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/hdk-sdlBundledSDL3Targets.cmake
|
||||
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/hdk-sdl
|
||||
COMPONENT hdk-sdl_dev
|
||||
)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
if(HDK_SDL_TESTS)
|
||||
if(HDK_TESTS)
|
||||
add_subdirectory(test)
|
||||
endif()
|
||||
|
||||
|
||||
# Install metadata files for release package
|
||||
install(FILES
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/README.md
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/../CHANGELOG.md
|
||||
DESTINATION ${CMAKE_INSTALL_DOCDIR}/hdk-sdl
|
||||
COMPONENT hdk-sdl_release
|
||||
OPTIONAL
|
||||
)
|
||||
|
||||
# Documentation Policy
|
||||
include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/HDKDocumentationPolicy.cmake)
|
||||
|
||||
# Set package dependencies for building debian packages correctly
|
||||
set(hdk-sdl_DEBIAN_DEV_DEPENDS "hdk-grid-dev (>= ${HDK_GRID_MIN_VERSION}), libsdl3-dev")
|
||||
set(hdk-sdl_DEBIAN_EXAMPLES_DEPENDS "hdk-sdl (>= 0.0.1), hdk-assets (>= 0.0.1)")
|
||||
|
||||
# CPack Packaging Policy
|
||||
include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/HDKPackaging.cmake)
|
||||
|
||||
@@ -0,0 +1,101 @@
|
||||
{
|
||||
"version": 6,
|
||||
"cmakeMinimumRequired": {
|
||||
"major": 3,
|
||||
"minor": 20,
|
||||
"patch": 0
|
||||
},
|
||||
"configurePresets": [
|
||||
{
|
||||
"name": "base",
|
||||
"hidden": true,
|
||||
"binaryDir": "${sourceDir}/build/${presetName}",
|
||||
"cacheVariables": {
|
||||
"CMAKE_BUILD_TYPE": "Debug"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "dev",
|
||||
"displayName": "Dev",
|
||||
"description": "Tests + examples enabled",
|
||||
"inherits": "base",
|
||||
"cacheVariables": {
|
||||
"HDK_TESTS": "ON"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "coverage",
|
||||
"displayName": "Coverage",
|
||||
"description": "Tests + coverage instrumentation",
|
||||
"inherits": "dev",
|
||||
"cacheVariables": {
|
||||
"HDK_COVERAGE": "ON"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "docs",
|
||||
"displayName": "Docs",
|
||||
"description": "Documentation only",
|
||||
"inherits": "base",
|
||||
"cacheVariables": {
|
||||
"HDK_DOCS": "ON"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "release",
|
||||
"displayName": "Release",
|
||||
"description": "Optimised release build with examples",
|
||||
"inherits": "base",
|
||||
"cacheVariables": {
|
||||
"CMAKE_BUILD_TYPE": "Release",
|
||||
"HDK_EXAMPLES": "ON",
|
||||
"HDK_INSTALL_EXAMPLES": "ON",
|
||||
"HDK_DOCS": "ON"
|
||||
}
|
||||
}
|
||||
],
|
||||
"buildPresets": [
|
||||
{
|
||||
"name": "dev",
|
||||
"configurePreset": "dev"
|
||||
},
|
||||
{
|
||||
"name": "coverage",
|
||||
"configurePreset": "coverage"
|
||||
},
|
||||
{
|
||||
"name": "docs",
|
||||
"configurePreset": "docs"
|
||||
},
|
||||
{
|
||||
"name": "release",
|
||||
"configurePreset": "release"
|
||||
}
|
||||
],
|
||||
"testPresets": [
|
||||
{
|
||||
"name": "test-dev",
|
||||
"displayName": "Test (dev)",
|
||||
"configurePreset": "dev",
|
||||
"output": {
|
||||
"outputOnFailure": true
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "test-coverage",
|
||||
"displayName": "Test (coverage)",
|
||||
"configurePreset": "coverage",
|
||||
"output": {
|
||||
"outputOnFailure": true
|
||||
}
|
||||
}
|
||||
],
|
||||
"packagePresets": [
|
||||
{
|
||||
"name": "Release",
|
||||
"description": "",
|
||||
"displayName": "",
|
||||
"configurePreset": "release"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
@@ -6,9 +6,25 @@ Use classes without declaring pointers to them, knowing that copying or referenc
|
||||
|
||||
## Dependencies
|
||||
|
||||
- holodeck-grid
|
||||
- [hdk-grid](https://git.ufp.institute/ufp/hdk-grid.git)
|
||||
- [SDL3](https://www.libsdl.org/)
|
||||
|
||||
## Building
|
||||
|
||||
To build the hdk-sdl, checkout the source, change into the source directory, make a build directory & run the following commands in the root of the repository:
|
||||
|
||||
```bash
|
||||
git clone https://git.ufp.institute/ufp/hdk-sdl.git
|
||||
mkdir build-hdk-sdl
|
||||
cd build-hdk-sdl
|
||||
cmake ../hdk-sdl
|
||||
cmake --build .
|
||||
```
|
||||
|
||||
This may require the building of SDL if your system does not have the required version installed.
|
||||
See [SDL3 Build Dependencies](https://wiki.libsdl.org/SDL3/README-linux#build-dependencies) if SDL fails to build on your machine.
|
||||
|
||||
|
||||
## Naming Conventions
|
||||
|
||||
API that is 1 to 1 with SDL with otherwise minimal wrapping will be as close to the original SDL function call as possible: for example, `SDL_CreateWindow` will be wrapped by `hd::sdl::Window::Create`.
|
||||
@@ -29,162 +45,39 @@ Within `include/hdk/sdl` there are folders for each SDL3 header files, and withi
|
||||
|
||||
With this entirely header-only and inline design, there is no need for a corresponding .cpp and the resulting compiled code should be as efficient as if you were using the raw SDL3 API directly, while still benefiting from the safety and convenience of C++ RAII and wrapper classes.
|
||||
|
||||
## SDL API Coverage
|
||||
## Dependency Resolution
|
||||
|
||||
Most links are from Links from [API by Category](https://wiki.libsdl.org/SDL3/APIByCategory), then those respective pages are used to fill in the rest of the checklist.
|
||||
`hdk-sdl` resolves SDL3 with a system-first policy by default:
|
||||
|
||||
In progress/complete:
|
||||
1. Try `find_package(SDL3 <minimum>)`.
|
||||
2. If unavailable or too old, fall back to `FetchContent`.
|
||||
|
||||
- By category:
|
||||
- [ ] BASICS
|
||||
- [~] [Category Video][]
|
||||
- [x] `hdk::sdl::Window`
|
||||
- [x] `hdk::sdl::Display`
|
||||
- [ ] [Category Surface][]
|
||||
- [x] `hdk::sdl::Surface`
|
||||
- [ ] [Category Main][]
|
||||
- [ ] [Category Init][]
|
||||
- [ ] [Category Hints][]
|
||||
- [x] [Category Properties][]
|
||||
- [ ] [Category Error][]
|
||||
- [ ] [Category Log][]
|
||||
- [ ] [Category Assert][]
|
||||
- [ ] [Category Version][]
|
||||
- [ ] [Category Events][]
|
||||
- [ ] [Category Keyboard][]
|
||||
- [ ] [Category Keycode][]
|
||||
- [ ] [Category Scancode][]
|
||||
- [ ] [Category Mouse][]
|
||||
- [ ] [Category Joystick][]
|
||||
- [ ] [Category Gamepad][]
|
||||
- [ ] [Category Touch][]
|
||||
- [ ] [Category Pen][]
|
||||
- [ ] [Category Sensor][]
|
||||
- [ ] [Category HIDAPI][]
|
||||
- [ ] [Category Render][]
|
||||
- [ ] [Category Pixels][]
|
||||
- [ ] [Category Blendmode][]
|
||||
- [ ] [Category Rect][]
|
||||
- [ ] [Category Clipboard][]
|
||||
- [ ] [Category Vulkan][]
|
||||
- [ ] [Category Metal][]
|
||||
- [ ] [Category Camera][]
|
||||
- [ ] HAPTIC
|
||||
- [ ] [Category Haptic][]
|
||||
- [ ] AUDIO
|
||||
- [ ] [Category Audio][]
|
||||
- [ ] GPU
|
||||
- [ ] [Category GPU][]
|
||||
- [ ] Time
|
||||
- [ ] [Category Timer][]
|
||||
- [ ] [Category Time][]
|
||||
- [ ] THREADS
|
||||
- [ ] [Category Thread][]
|
||||
- [ ] [Category Mutex][]
|
||||
- [ ] [Category Atomic][]
|
||||
- [ ] FILE I/O
|
||||
- [ ] [Category Filesystem][]
|
||||
- [ ] [Category Storage][]
|
||||
- [ ] [Category IOStream][]
|
||||
- [ ] [Category AsyncIO][]
|
||||
- [ ] PLATFORM
|
||||
- [ ] [Category Platform][]
|
||||
- [ ] [Category CPUInfo][]
|
||||
- [ ] [Category Intrinsics][]
|
||||
- [ ] [Category Endian][]
|
||||
- [ ] [Category Bits][]
|
||||
- [ ] MISC
|
||||
- [N] [Category Shared Object][]
|
||||
- [ ] [Category Process][]
|
||||
- [ ] [Category Power][]
|
||||
- [ ] [Category Messagebox][]
|
||||
- [ ] [Category Dialog][]
|
||||
- [ ] [Category Tray][]
|
||||
- [ ] [Category Locale][]
|
||||
- [ ] [Category System][]
|
||||
- [ ] [Category Stdinc][]
|
||||
- [ ] [Category GUID][]
|
||||
- [ ] [Category Misc][]
|
||||
Relevant CMake options:
|
||||
|
||||
<!--A-->
|
||||
[Category Shared Object]: <https://wiki.libsdl.org/SDL3/CategorySharedObject>
|
||||
[Category Assert]: https://wiki.libsdl.org/SDL3/CategoryAssert
|
||||
[Category AsyncIO]: <https://wiki.libsdl.org/SDL3/CategoryAsyncIO>
|
||||
[Category Atomic]: <https://wiki.libsdl.org/SDL3/CategoryAtomic>
|
||||
[Category Audio]: <https://wiki.libsdl.org/SDL3/CategoryAudio>
|
||||
<!--B-->
|
||||
[Category Bits]: <https://wiki.libsdl.org/SDL3/CategoryBits>
|
||||
[Category Blendmode]: <https://wiki.libsdl.org/SDL3/CategoryBlendmode>
|
||||
<!--C-->
|
||||
[Category Camera]: <https://wiki.libsdl.org/SDL3/CategoryCamera>
|
||||
[Category CPUInfo]: <https://wiki.libsdl.org/SDL3/CategoryCPUInfo>
|
||||
<!--D-->
|
||||
[Category Dialog]: <https://wiki.libsdl.org/SDL3/CategoryDialog>
|
||||
<!--E-->
|
||||
[Category Endian]: <https://wiki.libsdl.org/SDL3/CategoryEndian>
|
||||
[Category Error]: https://wiki.libsdl.org/SDL3/CategoryError
|
||||
[Category Events]: <https://wiki.libsdl.org/SDL3/CategoryEvents>
|
||||
<!--F-->
|
||||
[Category Filesystem]: <https://wiki.libsdl.org/SDL3/CategoryFilesystem>
|
||||
<!--G-->
|
||||
[Category Gamepad]: <https://wiki.libsdl.org/SDL3/CategoryGamepad>
|
||||
[Category GPU]: <https://wiki.libsdl.org/SDL3/CategoryGPU>
|
||||
[Category GUID]: <https://wiki.libsdl.org/SDL3/CategoryGUID>
|
||||
<!--H-->
|
||||
[Category Haptic]: <https://wiki.libsdl.org/SDL3/CategoryHaptic>
|
||||
[Category HIDAPI]: <https://wiki.libsdl.org/SDL3/CategoryHIDAPI>
|
||||
[Category Hints]: https://wiki.libsdl.org/SDL3/CategoryHints
|
||||
<!--I-->
|
||||
[Category Init]: https://wiki.libsdl.org/SDL3/CategoryInit
|
||||
[Category Intrinsics]: <https://wiki.libsdl.org/SDL3/CategoryIntrinsics>
|
||||
[Category IOStream]: <https://wiki.libsdl.org/SDL3/CategoryIOStream>
|
||||
<!--J-->
|
||||
[Category Joystick]: <https://wiki.libsdl.org/SDL3/CategoryJoystick>
|
||||
<!--K-->
|
||||
[Category Keyboard]: <https://wiki.libsdl.org/SDL3/CategoryKeyboard>
|
||||
[Category Keycode]: <https://wiki.libsdl.org/SDL3/CategoryKeycode>
|
||||
<!--L-->
|
||||
[Category Locale]: <https://wiki.libsdl.org/SDL3/CategoryLocale>
|
||||
[Category Log]: https://wiki.libsdl.org/SDL3/CategoryLog
|
||||
<!--M-->
|
||||
[Category Main]: https://wiki.libsdl.org/SDL3/CategoryMain
|
||||
[Category Messagebox]: <https://wiki.libsdl.org/SDL3/CategoryMessagebox>
|
||||
[Category Metal]: <https://wiki.libsdl.org/SDL3/CategoryMetal>
|
||||
[Category Misc]: <https://wiki.libsdl.org/SDL3/CategoryMisc>
|
||||
[Category Mouse]: <https://wiki.libsdl.org/SDL3/CategoryMouse>
|
||||
[Category Mutex]: <https://wiki.libsdl.org/SDL3/CategoryMutex>
|
||||
<!--N-->
|
||||
<!--O-->
|
||||
<!--P-->
|
||||
[Category Pen]: <https://wiki.libsdl.org/SDL3/CategoryPen>
|
||||
[Category Pixels]: <https://wiki.libsdl.org/SDL3/CategoryPixels>
|
||||
[Category Platform]: <https://wiki.libsdl.org/SDL3/CategoryPlatform>
|
||||
[Category Power]: <https://wiki.libsdl.org/SDL3/CategoryPower>
|
||||
[Category Process]: <https://wiki.libsdl.org/SDL3/CategoryProcess>
|
||||
[Category Properties]: https://wiki.libsdl.org/SDL3/CategoryProperties
|
||||
<!--Q-->
|
||||
<!--R-->
|
||||
[Category Rect]: <https://wiki.libsdl.org/SDL3/CategoryRect>
|
||||
[Category Render]: <https://wiki.libsdl.org/SDL3/CategoryRender>
|
||||
<!--S-->
|
||||
[Category Scancode]: <https://wiki.libsdl.org/SDL3/CategoryScancode>
|
||||
[Category Sensor]: <https://wiki.libsdl.org/SDL3/CategorySensor>
|
||||
[Category Stdinc]: <https://wiki.libsdl.org/SDL3/CategoryStdinc>
|
||||
[Category Storage]: <https://wiki.libsdl.org/SDL3/CategoryStorage>
|
||||
[Category Surface]: <https://wiki.libsdl.org/SDL3/CategorySurface>
|
||||
[Category System]: <https://wiki.libsdl.org/SDL3/CategorySystem>
|
||||
<!--T-->
|
||||
[Category Thread]: <https://wiki.libsdl.org/SDL3/CategoryThread>
|
||||
[Category Time]: <https://wiki.libsdl.org/SDL3/CategoryTime>
|
||||
[Category Timer]: <https://wiki.libsdl.org/SDL3/CategoryTimer>
|
||||
[Category Touch]: <https://wiki.libsdl.org/SDL3/CategoryTouch>
|
||||
[Category Tray]: <https://wiki.libsdl.org/SDL3/CategoryTray>
|
||||
<!--U-->
|
||||
<!--V-->
|
||||
[Category Version]: https://wiki.libsdl.org/SDL3/CategoryVersion
|
||||
[Category Video]: https://wiki.libsdl.org/SDL3/CategoryVideo
|
||||
[Category Vulkan]: <https://wiki.libsdl.org/SDL3/CategoryVulkan>
|
||||
<!--W-->
|
||||
<!--X-->
|
||||
<!--Y-->
|
||||
<!--Z-->
|
||||
- `HDK_SDL_SYSTEM_SDL3`
|
||||
- `HDK_SDL_FETCH_SDL3_FALLBACK`
|
||||
- `HDK_SDL_MIN_SDL3_VERSION`
|
||||
|
||||
## Example Assets
|
||||
|
||||
When building examples, `hdk-sdl` resolves shared assets in this order:
|
||||
|
||||
1. Repository checkout assets (when building inside the HDK monorepo)
|
||||
2. Installed `hdk-assets` package with minimum version
|
||||
3. `FetchContent` fallback from `HDK_SDL_EXAMPLES_ASSETS_GIT_REPOSITORY`
|
||||
|
||||
Relevant CMake options:
|
||||
|
||||
- `HDK_SDL_EXAMPLES_FETCH_ASSETS`
|
||||
- `HDK_SDL_EXAMPLES_ASSETS_MIN_VERSION`
|
||||
- `HDK_SDL_EXAMPLES_ASSETS_GIT_REPOSITORY`
|
||||
- `HDK_SDL_EXAMPLES_ASSETS_GIT_TAG`
|
||||
|
||||
## Installation Layout
|
||||
|
||||
Installed examples and assets are organized under one prefix using GNU install dirs.
|
||||
|
||||
- Example binaries: `${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_BINDIR}`
|
||||
- Shared assets: `${CMAKE_INSTALL_PREFIX}/${HDK_SDL_EXAMPLES_INSTALL_ASSETSDIR}`
|
||||
|
||||
The default shared assets directory is `assets`, giving `${CMAKE_INSTALL_PREFIX}/assets`.
|
||||
|
||||
@@ -0,0 +1,91 @@
|
||||
include(CMakeParseArguments)
|
||||
|
||||
# Resolve a dependency in this order:
|
||||
# 1) already-defined target(s)
|
||||
# 2) find_package() system package(s)
|
||||
# 3) FetchContent fallback
|
||||
function(hdk_resolve_dependency)
|
||||
set(_opts "")
|
||||
set(_one_value NAME MIN_VERSION USE_SYSTEM FETCH_FALLBACK GIT_REPOSITORY GIT_TAG FETCHCONTENT_NAME OUT_VAR)
|
||||
set(_multi_value TARGETS PACKAGE_NAMES)
|
||||
cmake_parse_arguments(HDK_DEP "${_opts}" "${_one_value}" "${_multi_value}" ${ARGN})
|
||||
|
||||
if(NOT HDK_DEP_NAME)
|
||||
message(FATAL_ERROR "hdk_resolve_dependency requires NAME")
|
||||
endif()
|
||||
if(NOT HDK_DEP_TARGETS)
|
||||
message(FATAL_ERROR "hdk_resolve_dependency(${HDK_DEP_NAME}) requires TARGETS")
|
||||
endif()
|
||||
if(NOT HDK_DEP_FETCHCONTENT_NAME)
|
||||
message(FATAL_ERROR "hdk_resolve_dependency(${HDK_DEP_NAME}) requires FETCHCONTENT_NAME")
|
||||
endif()
|
||||
|
||||
set(_hdk_dep_resolved_target "")
|
||||
foreach(_target IN LISTS HDK_DEP_TARGETS)
|
||||
if(TARGET ${_target})
|
||||
set(_hdk_dep_resolved_target ${_target})
|
||||
break()
|
||||
endif()
|
||||
endforeach()
|
||||
|
||||
if(NOT _hdk_dep_resolved_target AND HDK_DEP_USE_SYSTEM)
|
||||
foreach(_pkg IN LISTS HDK_DEP_PACKAGE_NAMES)
|
||||
if(HDK_DEP_MIN_VERSION)
|
||||
find_package(${_pkg} ${HDK_DEP_MIN_VERSION} QUIET CONFIG)
|
||||
else()
|
||||
find_package(${_pkg} QUIET CONFIG)
|
||||
endif()
|
||||
|
||||
foreach(_target IN LISTS HDK_DEP_TARGETS)
|
||||
if(TARGET ${_target})
|
||||
set(_hdk_dep_resolved_target ${_target})
|
||||
break()
|
||||
endif()
|
||||
endforeach()
|
||||
|
||||
if(_hdk_dep_resolved_target)
|
||||
break()
|
||||
endif()
|
||||
endforeach()
|
||||
endif()
|
||||
|
||||
if(NOT _hdk_dep_resolved_target)
|
||||
if(NOT HDK_DEP_FETCH_FALLBACK)
|
||||
if(HDK_DEP_MIN_VERSION)
|
||||
message(FATAL_ERROR "${HDK_DEP_NAME} >= ${HDK_DEP_MIN_VERSION} not found and fallback is disabled")
|
||||
else()
|
||||
message(FATAL_ERROR "${HDK_DEP_NAME} not found and fallback is disabled")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
if(NOT HDK_DEP_GIT_REPOSITORY)
|
||||
message(FATAL_ERROR "hdk_resolve_dependency(${HDK_DEP_NAME}) fallback requires GIT_REPOSITORY")
|
||||
endif()
|
||||
if(NOT HDK_DEP_GIT_TAG)
|
||||
message(FATAL_ERROR "hdk_resolve_dependency(${HDK_DEP_NAME}) fallback requires GIT_TAG")
|
||||
endif()
|
||||
|
||||
include(FetchContent)
|
||||
FetchContent_Declare(
|
||||
${HDK_DEP_FETCHCONTENT_NAME}
|
||||
GIT_REPOSITORY ${HDK_DEP_GIT_REPOSITORY}
|
||||
GIT_TAG ${HDK_DEP_GIT_TAG}
|
||||
)
|
||||
FetchContent_MakeAvailable(${HDK_DEP_FETCHCONTENT_NAME})
|
||||
|
||||
foreach(_target IN LISTS HDK_DEP_TARGETS)
|
||||
if(TARGET ${_target})
|
||||
set(_hdk_dep_resolved_target ${_target})
|
||||
break()
|
||||
endif()
|
||||
endforeach()
|
||||
endif()
|
||||
|
||||
if(NOT _hdk_dep_resolved_target)
|
||||
message(FATAL_ERROR "${HDK_DEP_NAME} could not be resolved to any expected target: ${HDK_DEP_TARGETS}")
|
||||
endif()
|
||||
|
||||
if(HDK_DEP_OUT_VAR)
|
||||
set(${HDK_DEP_OUT_VAR} ${_hdk_dep_resolved_target} PARENT_SCOPE)
|
||||
endif()
|
||||
endfunction()
|
||||
@@ -0,0 +1,70 @@
|
||||
# HDK Documentation Policy
|
||||
include(GNUInstallDirs)
|
||||
|
||||
option(HDK_DOCS "Build documentation for ${PROJECT_NAME}" OFF)
|
||||
|
||||
if(HDK_DOCS)
|
||||
find_package(Doxygen)
|
||||
if(DOXYGEN_FOUND)
|
||||
set(DOXYGEN_GENERATE_HTML YES)
|
||||
set(DOXYGEN_GENERATE_MAN YES)
|
||||
set(DOXYGEN_GENERATE_LATEX YES)
|
||||
|
||||
set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs)
|
||||
set(DOXYGEN_STRIP_FROM_PATH ${CMAKE_CURRENT_SOURCE_DIR})
|
||||
set(DOXYGEN_EXTRACT_ALL YES)
|
||||
set(DOXYGEN_DIRECTORY_GRAPH YES)
|
||||
set(DOXYGEN_JAVADOC_BANNER YES)
|
||||
set(DOXYGEN_JAVADOC_AUTOBRIEF YES)
|
||||
set(DOXYGEN_DOT_IMAGE_FORMAT svg)
|
||||
set(DOXYGEN_INTERACTIVE_SVG YES)
|
||||
set(DOXYGEN_INTERNAL_DOCS YES)
|
||||
set(DOXYGEN_TIMESTAMP YES)
|
||||
set(DOXYGEN_RECURSIVE YES)
|
||||
set(DOXYGEN_TAB_SIZE 2)
|
||||
set(DOXYGEN_BUILTIN_STL_SUPPORT YES)
|
||||
set(DOXYGEN_HTML_DYNAMIC_SECTIONS YES)
|
||||
set(DOXYGEN_GENERATE_TREEVIEW YES)
|
||||
set(DOXYGEN_FULL_SIDEBAR YES)
|
||||
set(DOXYGEN_QUIET YES)
|
||||
set(DOXYGEN_SOURCE_BROWSER YES)
|
||||
set(DOXYGEN_VERBATIM_HEADERS YES)
|
||||
set(DOXYGEN_REFERENCED_BY_RELATION YES)
|
||||
set(DOXYGEN_REFERENCES_RELATION YES)
|
||||
|
||||
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/INDEX.md")
|
||||
set(DOXYGEN_USE_MDFILE_AS_MAINPAGE INDEX.md)
|
||||
set(_hdk_doc_mainpage "${CMAKE_CURRENT_SOURCE_DIR}/INDEX.md")
|
||||
elseif(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/README.md")
|
||||
set(DOXYGEN_USE_MDFILE_AS_MAINPAGE README.md)
|
||||
set(_hdk_doc_mainpage "${CMAKE_CURRENT_SOURCE_DIR}/README.md")
|
||||
endif()
|
||||
|
||||
doxygen_add_docs(${PROJECT_NAME}-docs
|
||||
${_hdk_doc_mainpage}
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/include/
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/src/
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/*.md
|
||||
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
||||
COMMENT "Generate ${PROJECT_NAME} API Documentation"
|
||||
)
|
||||
|
||||
# Automatically install documentation
|
||||
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs/html/
|
||||
DESTINATION ${CMAKE_INSTALL_DOCDIR}
|
||||
COMPONENT ${PROJECT_NAME}_doc
|
||||
OPTIONAL)
|
||||
|
||||
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs/man/man3/
|
||||
DESTINATION ${CMAKE_INSTALL_MANDIR}/man3
|
||||
COMPONENT ${PROJECT_NAME}_doc
|
||||
OPTIONAL)
|
||||
|
||||
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs/latex/
|
||||
DESTINATION ${CMAKE_INSTALL_DOCDIR}/latex
|
||||
COMPONENT ${PROJECT_NAME}_doc
|
||||
OPTIONAL)
|
||||
else()
|
||||
message(WARNING "Doxygen not found, API documentation will not be generated for ${PROJECT_NAME}.")
|
||||
endif()
|
||||
endif()
|
||||
@@ -0,0 +1,72 @@
|
||||
include(CMakeParseArguments)
|
||||
include(FetchContent)
|
||||
|
||||
# Resolve hdk-assets for examples only.
|
||||
function(hdk_resolve_example_assets)
|
||||
set(_opts "")
|
||||
set(_one_value OUT_VAR FETCH_OPTION MIN_VERSION GIT_REPOSITORY GIT_TAG CONTEXT)
|
||||
cmake_parse_arguments(HDK_ASSETS "${_opts}" "${_one_value}" "" ${ARGN})
|
||||
|
||||
if(NOT HDK_ASSETS_OUT_VAR)
|
||||
message(FATAL_ERROR "hdk_resolve_example_assets requires OUT_VAR")
|
||||
endif()
|
||||
|
||||
set(_resolved_assets_dir "")
|
||||
set(_repo_assets_dir "${CMAKE_CURRENT_SOURCE_DIR}/../../assets")
|
||||
if(EXISTS "${_repo_assets_dir}/textures")
|
||||
set(_resolved_assets_dir "${_repo_assets_dir}")
|
||||
endif()
|
||||
|
||||
if(NOT _resolved_assets_dir)
|
||||
if(HDK_ASSETS_MIN_VERSION)
|
||||
find_package(hdk_assets ${HDK_ASSETS_MIN_VERSION} QUIET CONFIG NAMES hdk-assets hdk_assets)
|
||||
else()
|
||||
find_package(hdk_assets QUIET CONFIG NAMES hdk-assets hdk_assets)
|
||||
endif()
|
||||
|
||||
foreach(_candidate_var IN ITEMS HDK_ASSETS_SOURCE_DIR HDK_ASSETS_DIR hdk_assets_SOURCE_DIR hdk_assets_DIR)
|
||||
if(NOT _resolved_assets_dir AND DEFINED ${_candidate_var})
|
||||
set(_candidate_dir "${${_candidate_var}}")
|
||||
if(EXISTS "${_candidate_dir}/textures")
|
||||
set(_resolved_assets_dir "${_candidate_dir}")
|
||||
endif()
|
||||
endif()
|
||||
endforeach()
|
||||
|
||||
if(NOT _resolved_assets_dir AND DEFINED hdk_assets_DIR)
|
||||
get_filename_component(_hdk_assets_prefix "${hdk_assets_DIR}" DIRECTORY)
|
||||
get_filename_component(_hdk_assets_prefix "${_hdk_assets_prefix}" DIRECTORY)
|
||||
get_filename_component(_hdk_assets_prefix "${_hdk_assets_prefix}" DIRECTORY)
|
||||
if(EXISTS "${_hdk_assets_prefix}/assets/textures")
|
||||
set(_resolved_assets_dir "${_hdk_assets_prefix}/assets")
|
||||
endif()
|
||||
endif()
|
||||
endif()
|
||||
|
||||
if(NOT _resolved_assets_dir)
|
||||
if(NOT HDK_ASSETS_FETCH_OPTION)
|
||||
if(HDK_ASSETS_CONTEXT)
|
||||
message(FATAL_ERROR "No suitable hdk-assets source found for ${HDK_ASSETS_CONTEXT} and fetch fallback is disabled")
|
||||
else()
|
||||
message(FATAL_ERROR "No suitable hdk-assets source found and fetch fallback is disabled")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
if(NOT HDK_ASSETS_GIT_REPOSITORY)
|
||||
message(FATAL_ERROR "hdk_resolve_example_assets fallback requires GIT_REPOSITORY")
|
||||
endif()
|
||||
if(NOT HDK_ASSETS_GIT_TAG)
|
||||
message(FATAL_ERROR "hdk_resolve_example_assets fallback requires GIT_TAG")
|
||||
endif()
|
||||
|
||||
FetchContent_Declare(
|
||||
hdk_assets
|
||||
GIT_REPOSITORY ${HDK_ASSETS_GIT_REPOSITORY}
|
||||
GIT_TAG ${HDK_ASSETS_GIT_TAG}
|
||||
)
|
||||
FetchContent_MakeAvailable(hdk_assets)
|
||||
set(_resolved_assets_dir "${hdk_assets_SOURCE_DIR}")
|
||||
endif()
|
||||
|
||||
set(${HDK_ASSETS_OUT_VAR} "${_resolved_assets_dir}" PARENT_SCOPE)
|
||||
endfunction()
|
||||
@@ -0,0 +1,72 @@
|
||||
# HDK Packaging Policy
|
||||
|
||||
# Define variables for CPack
|
||||
set(CPACK_PACKAGE_NAME "${CMAKE_PROJECT_NAME}")
|
||||
set(CPACK_PACKAGE_VERSION "${CMAKE_PROJECT_VERSION}")
|
||||
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "${CMAKE_PROJECT_DESCRIPTION}")
|
||||
|
||||
# We mainly want component-based installations for nice split packages
|
||||
set(CPACK_DEB_COMPONENT_INSTALL ON CACHE INTERNAL "Enable component install")
|
||||
|
||||
# Setup Debian Generator
|
||||
set(CPACK_GENERATOR "DEB" CACHE INTERNAL "Deb generator")
|
||||
set(CPACK_DEBIAN_PACKAGE_MAINTAINER "HDK Team" CACHE INTERNAL "HDK Team")
|
||||
|
||||
# Source package generator
|
||||
set(CPACK_SOURCE_GENERATOR "TGZ;ZIP" CACHE INTERNAL "Sources")
|
||||
set(CPACK_SOURCE_IGNORE_FILES
|
||||
"/.git/"
|
||||
"/build/"
|
||||
"/build.*/"
|
||||
".*~$"
|
||||
CACHE INTERNAL "Ignores"
|
||||
)
|
||||
|
||||
# Component specific configurations
|
||||
string(TOUPPER "${PROJECT_NAME}" UPPER_PROJ_NAME)
|
||||
|
||||
# CPack explicitly needs UPPERCASE. Hyphens must remain hyphens in modern CMake CPack.
|
||||
# Only include RELEASE component for actual library/asset projects, not the root
|
||||
if(NOT CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
|
||||
set(COMP_RELEASE "${UPPER_PROJ_NAME}_RELEASE")
|
||||
endif()
|
||||
|
||||
set(COMP_DEV "${UPPER_PROJ_NAME}_DEV")
|
||||
set(COMP_DOC "${UPPER_PROJ_NAME}_DOC")
|
||||
set(COMP_EXAMPLES "${UPPER_PROJ_NAME}_EXAMPLES")
|
||||
|
||||
if(DEFINED COMP_RELEASE)
|
||||
set(CPACK_DEBIAN_${COMP_RELEASE}_PACKAGE_NAME "${PROJECT_NAME}" CACHE INTERNAL "")
|
||||
set(CPACK_DEBIAN_${COMP_RELEASE}_FILE_NAME "${PROJECT_NAME}-${CPACK_PACKAGE_VERSION}.deb" CACHE INTERNAL "")
|
||||
endif()
|
||||
|
||||
set(CPACK_DEBIAN_${COMP_DEV}_PACKAGE_NAME "${PROJECT_NAME}-dev" CACHE INTERNAL "")
|
||||
set(CPACK_DEBIAN_${COMP_DOC}_PACKAGE_NAME "${PROJECT_NAME}-doc" CACHE INTERNAL "")
|
||||
set(CPACK_DEBIAN_${COMP_EXAMPLES}_PACKAGE_NAME "${PROJECT_NAME}-examples" CACHE INTERNAL "")
|
||||
|
||||
set(CPACK_DEBIAN_${COMP_DEV}_FILE_NAME "${PROJECT_NAME}-${CPACK_PACKAGE_VERSION}-dev.deb" CACHE INTERNAL "")
|
||||
set(CPACK_DEBIAN_${COMP_DOC}_FILE_NAME "${PROJECT_NAME}-${CPACK_PACKAGE_VERSION}-doc.deb" CACHE INTERNAL "")
|
||||
set(CPACK_DEBIAN_${COMP_EXAMPLES}_FILE_NAME "${PROJECT_NAME}-${CPACK_PACKAGE_VERSION}-examples.deb" CACHE INTERNAL "")
|
||||
|
||||
# Apply dependencies for each component
|
||||
if(DEFINED ${PROJECT_NAME}_DEBIAN_RELEASE_DEPENDS)
|
||||
set(CPACK_DEBIAN_${COMP_RELEASE}_PACKAGE_DEPENDS "${${PROJECT_NAME}_DEBIAN_RELEASE_DEPENDS}" CACHE INTERNAL "")
|
||||
endif()
|
||||
|
||||
if(DEFINED ${PROJECT_NAME}_DEBIAN_DEV_DEPENDS)
|
||||
set(CPACK_DEBIAN_${COMP_DEV}_PACKAGE_DEPENDS "${${PROJECT_NAME}_DEBIAN_DEV_DEPENDS}" CACHE INTERNAL "")
|
||||
elseif(DEFINED ${PROJECT_NAME}_DEBIAN_DEPENDS)
|
||||
set(CPACK_DEBIAN_${COMP_DEV}_PACKAGE_DEPENDS "${${PROJECT_NAME}_DEBIAN_DEPENDS}" CACHE INTERNAL "")
|
||||
endif()
|
||||
|
||||
if(DEFINED ${PROJECT_NAME}_DEBIAN_EXAMPLES_DEPENDS)
|
||||
set(CPACK_DEBIAN_${COMP_EXAMPLES}_PACKAGE_DEPENDS "${${PROJECT_NAME}_DEBIAN_EXAMPLES_DEPENDS}" CACHE INTERNAL "")
|
||||
endif()
|
||||
|
||||
if(DEFINED ${PROJECT_NAME}_DEBIAN_DOC_DEPENDS)
|
||||
set(CPACK_DEBIAN_${COMP_DOC}_PACKAGE_DEPENDS "${${PROJECT_NAME}_DEBIAN_DOC_DEPENDS}" CACHE INTERNAL "")
|
||||
endif()
|
||||
|
||||
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
|
||||
include(CPack)
|
||||
endif()
|
||||
+46
-9
@@ -1,31 +1,68 @@
|
||||
# Simple examples for using hdk-sdl.
|
||||
|
||||
include(FetchContent)
|
||||
include(GNUInstallDirs)
|
||||
|
||||
option(HDK_SDL_INSTALL_EXAMPLES "Install hdk-sdl example binaries and assets" OFF)
|
||||
if(DEFINED HDK_CMAKE_POLICY_DIR AND EXISTS "${HDK_CMAKE_POLICY_DIR}/HDKExampleAssetsPolicy.cmake")
|
||||
include("${HDK_CMAKE_POLICY_DIR}/HDKExampleAssetsPolicy.cmake")
|
||||
elseif(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/../../cmake/HDKExampleAssetsPolicy.cmake")
|
||||
include("${CMAKE_CURRENT_SOURCE_DIR}/../../cmake/HDKExampleAssetsPolicy.cmake")
|
||||
elseif(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/../cmake/HDKExampleAssetsPolicy.cmake")
|
||||
include("${CMAKE_CURRENT_SOURCE_DIR}/../cmake/HDKExampleAssetsPolicy.cmake")
|
||||
else()
|
||||
message(FATAL_ERROR "Unable to locate HDKExampleAssetsPolicy.cmake")
|
||||
endif()
|
||||
|
||||
set(HDK_SDL_EXAMPLES_ASSETS_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/assets)
|
||||
set(HDK_SDL_EXAMPLES_ASSETS_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/../assets)
|
||||
if(NOT DEFINED HDK_INSTALL_EXAMPLES)
|
||||
set(HDK_INSTALL_EXAMPLES OFF)
|
||||
endif()
|
||||
|
||||
option(HDK_INSTALL_EXAMPLES "Install hdk-sdl example binaries and assets" ${HDK_INSTALL_EXAMPLES})
|
||||
option(HDK_EXAMPLES_FETCH_ASSETS "Fetch hdk-assets when no suitable package is found" ON)
|
||||
|
||||
if(NOT DEFINED HDK_ASSETS_MIN_VERSION)
|
||||
set(HDK_ASSETS_MIN_VERSION "0.0.1")
|
||||
endif()
|
||||
|
||||
if(NOT DEFINED HDK_ASSETS_GIT_REPOSITORY)
|
||||
set(HDK_ASSETS_GIT_REPOSITORY "https://git.ufp.institute/ufp/hdk-assets.git")
|
||||
endif()
|
||||
|
||||
if(NOT DEFINED HDK_INSTALL_ASSETSDIR)
|
||||
set(HDK_INSTALL_ASSETSDIR "assets")
|
||||
endif()
|
||||
|
||||
hdk_resolve_example_assets(
|
||||
OUT_VAR HDK_EXAMPLES_ASSETS_SOURCE_DIR
|
||||
FETCH_OPTION ${HDK_EXAMPLES_FETCH_ASSETS}
|
||||
MIN_VERSION ${HDK_ASSETS_MIN_VERSION}
|
||||
GIT_REPOSITORY ${HDK_ASSETS_GIT_REPOSITORY}
|
||||
GIT_TAG v${HDK_ASSETS_MIN_VERSION}
|
||||
CONTEXT "hdk-sdl examples"
|
||||
)
|
||||
set(HDK_EXAMPLES_ASSETS_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/../assets)
|
||||
|
||||
add_executable(HelloRenderer2D HelloRenderer2D.cpp)
|
||||
target_link_libraries(HelloRenderer2D PRIVATE hdk-sdl)
|
||||
|
||||
# Stage shared example assets beside the example executables in the build tree.
|
||||
add_custom_command(TARGET HelloRenderer2D POST_BUILD
|
||||
COMMAND ${CMAKE_COMMAND} -E rm -rf ${HDK_SDL_EXAMPLES_ASSETS_BUILD_DIR}
|
||||
COMMAND ${CMAKE_COMMAND} -E rm -rf ${HDK_EXAMPLES_ASSETS_BUILD_DIR}
|
||||
COMMAND ${CMAKE_COMMAND} -E copy_directory
|
||||
${HDK_SDL_EXAMPLES_ASSETS_SOURCE_DIR}
|
||||
${HDK_SDL_EXAMPLES_ASSETS_BUILD_DIR}
|
||||
${HDK_EXAMPLES_ASSETS_SOURCE_DIR}
|
||||
${HDK_EXAMPLES_ASSETS_BUILD_DIR}
|
||||
COMMENT "Staging hdk-sdl example assets"
|
||||
VERBATIM
|
||||
)
|
||||
|
||||
if(HDK_SDL_INSTALL_EXAMPLES)
|
||||
if(HDK_INSTALL_EXAMPLES)
|
||||
install(TARGETS HelloRenderer2D
|
||||
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
|
||||
COMPONENT hdk-sdl_examples
|
||||
)
|
||||
|
||||
install(DIRECTORY ${HDK_SDL_EXAMPLES_ASSETS_SOURCE_DIR}/
|
||||
DESTINATION assets
|
||||
install(DIRECTORY ${HDK_EXAMPLES_ASSETS_SOURCE_DIR}/
|
||||
DESTINATION ${HDK_INSTALL_ASSETSDIR}
|
||||
COMPONENT hdk-sdl_examples
|
||||
)
|
||||
endif()
|
||||
Submodule
+1
Submodule hdk-cmake added at 141681e8cf
@@ -9,6 +9,10 @@ namespace hdk::sdl {
|
||||
namespace evt {
|
||||
class EventConduit;
|
||||
}
|
||||
/**
|
||||
* @todo https://wiki.libsdl.org/SDL3/SDL_SetWindowFillDocument
|
||||
*
|
||||
*/
|
||||
class Window : public hdk::grid::SharedPtrWrapper<SDL_Window> {
|
||||
public:
|
||||
friend class Renderer;
|
||||
|
||||
Reference in New Issue
Block a user