SketchUp 2025 C SDK Compatibility

pixelcruncher · March 14, 2025, 4:09pm

I’m in the process of upgrading my extension to support SU2025 PBR materials.

I successfully updated my extension, and it works fine in SU2025. I noticed I’m having issues loading my extension in older SketchUp versions (SU 2024 and SU 2023). Is the latest SDK supposed to work with older SketchUp versions ( SketchUp API 13.0, SketchUp 2025.0). I could not find it in the release notes: SketchUp C API: SketchUp C API Release Notes

The previous SDK was compatible with older versions because I could support SU2024, SU2023, and SU2022 with a single build.

Regards,
Thomas

tt_su · March 18, 2025, 10:37am

The SDK should be compatible.

Can you provide with some more specific details to what you’re running into?

pixelcruncher · March 19, 2025, 6:37am

In SketchUp 2024, I get the following error in the Ruby console when my plugin is compiled with the SDK (2025-0-571):

Running rayscaper mode=Debug, paths=["C:/Users/Thomas/dev/RayscaperBuilds/Debug/", "C:/Users/Thomas/dev/sketchup-ruby-api-tutorials"]

Globbing path: C:/Users/Thomas/dev/RayscaperBuilds/Debug/, path.encoding UTF-8

Exists? true

Loading Rayscaper 0.9.44 Beta...

Force installing Rayscaper: true.

Loading failed: 127: The specified procedure could not be found. - C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper/installed/Windows/3.2.2/0.9.44 Beta/resources/SUEX_Rayscaper.so

Successfully required: C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper.rb

Globbing path: C:/Users/Thomas/dev/sketchup-ruby-api-tutorials, path.encoding UTF-8

Exists? true

Error: #<LoadError: 126: The specified module could not be found. - C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper/installed/Windows/3.2.2/0.9.44 Beta/resources/SUEX_Rayscaper.so>

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper/extension_controller.rb:4:in `require_relative'

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper/extension_controller.rb:4:in `<top (required)>'

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper/main.rb:110:in `require'

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper/main.rb:110:in `<module:Rayscaper>'

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper/main.rb:5:in `<top (required)>'

C:/Program Files/SketchUp/SketchUp 2024/Tools/extensions.rb:197:in `require'

C:/Program Files/SketchUp/SketchUp 2024/Tools/extensions.rb:197:in `load'

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper.rb:18:in `register_extension'

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper.rb:18:in `<module:Rayscaper>'

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper.rb:6:in `<top (required)>'

C:/Users/Thomas/AppData/Roaming/SketchUp/SketchUp 2024/SketchUp/Plugins/!external.rb:32:in `require'

C:/Users/Thomas/AppData/Roaming/SketchUp/SketchUp 2024/SketchUp/Plugins/!external.rb:32:in `block (2 levels) in <top (required)>'

<internal:dir>:220:in `glob'

C:/Users/Thomas/AppData/Roaming/SketchUp/SketchUp 2024/SketchUp/Plugins/!external.rb:31:in `block in <top (required)>'

C:/Users/Thomas/AppData/Roaming/SketchUp/SketchUp 2024/SketchUp/Plugins/!external.rb:26:in `each'

C:/Users/Thomas/AppData/Roaming/SketchUp/SketchUp 2024/SketchUp/Plugins/!external.rb:26:in `<top (required)>'

Error: #<NameError: uninitialized constant Rayscaper::SUEX_Rayscaper>

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper/main.rb:113:in `<module:Rayscaper>'

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper/main.rb:5:in `<top (required)>'

C:/Program Files/SketchUp/SketchUp 2024/Tools/extensions.rb:197:in `require'

C:/Program Files/SketchUp/SketchUp 2024/Tools/extensions.rb:197:in `load'

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper.rb:18:in `register_extension'

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper.rb:18:in `<module:Rayscaper>'

C:/Users/Thomas/dev/RayscaperBuilds/Debug/rayscaper.rb:6:in `<top (required)>'

C:/Users/Thomas/AppData/Roaming/SketchUp/SketchUp 2024/SketchUp/Plugins/!external.rb:32:in `require'

C:/Users/Thomas/AppData/Roaming/SketchUp/SketchUp 2024/SketchUp/Plugins/!external.rb:32:in `block (2 levels) in <top (required)>'

<internal:dir>:220:in `glob'

C:/Users/Thomas/AppData/Roaming/SketchUp/SketchUp 2024/SketchUp/Plugins/!external.rb:31:in `block in <top (required)>'

C:/Users/Thomas/AppData/Roaming/SketchUp/SketchUp 2024/SketchUp/Plugins/!external.rb:26:in `each'

C:/Users/Thomas/AppData/Roaming/SketchUp/SketchUp 2024/SketchUp/Plugins/!external.rb:26:in `<top (required)>'

The DLL is actually in the correct location:

And looking at dependency walker, it seems that the DLL is not missing any downstream dependencies (except for Ruby, which I assume is loaded when running SU?):

If it helps, I can send you my plugin without encrypted Ruby code so you can try for yourself.

Thanks for your help!

Cheers,
Thomas

DanRathbun · March 19, 2025, 2:34pm

This error message usually means that the entry point function in the compiled so, dll, dylib or bundle cannot be found by Ruby. If you are using Ruby’s require method, then there must be an entry point function named Init_SUEX_Rayscaper(), (i.e., the prefix Init_ followed by the library filename minus the extension.)

pixelcruncher · March 19, 2025, 3:54pm

The symbol Init_SUEX_Rayscaper() is definitely there:

The plugin works just fine with SU2025; it fails when I try it on SU2024. It worked before the upgrade to the latest SDK on SU2022, SU2023, SU2024 and SU2025.

Regards,
Thomas

pixelcruncher · March 24, 2025, 4:55pm

Anything else I can provide, or something else I can look at to help me debug this problem? Any help is appreciated!

Thanks,
Thomas

DanRathbun · March 24, 2025, 6:37pm

My next suggestion would be to look at the targeted toolkit setting in MSVS.
However, it appears that the C SDK documentation intro page has not been updated for 2024 and 2025 releases in this regard.

pinging: @tt_su @bugra @CraigTrickett

bugra · March 24, 2025, 7:03pm

Ruby DLL’s name is different in SU 2023, which would explain why a build for 2025 won’t work there. But I’m not sure why it doesn’t work in 2024 (which has the same Ruby DLL I believe)

pixelcruncher · March 26, 2025, 2:28pm

Thanks for the suggestions.

To clarify on the Ruby versions, I’m building two DLLs of my C extensions. One targeting Ruby 2.7 (x64-msvcrt-ruby270.lib - SU 2023/2022) and the other one targeting Ruby 3.2 (x64-ucrt-ruby320.lib - SU2024/SU2025). Based on the SketchUp version, I’m copying the correct dll in my plugin directory and load it from there.

This has always worked for me so far.

sWilliams · March 27, 2025, 5:34pm

Greetings Thomas,

There is a system flag we can enable that will cause the kernel to log the diagnostic information created by a failed loadlibrary call. The flag is referred to as Show Loader Snaps (SLS) Show Loader Snaps - Windows drivers | Microsoft Learn. The SLS flag is enabled by a tool called gflags.exe GFlags - Windows drivers | Microsoft Learn which is part of the Debugging Tools for Windows and would have been installed on you computer as part of Visual Studio.

Summarizing the comments from a short discussion of using gflags.exe on this Stackoverflow page.

The Microsoft gflags tool will always tell you exactly what dependency is failing to load and why.

Run gflags -i your_application.exe +sls. After that execute the application under the debugger to capture the loader traces.
.
. debug you application
.
Run gflags -i your_application.exe -sls afterwards to disable the loader traces.

Below are the steps to use gflags to diagnose problems with your SUEX_rayscraper.so file.

Disable Rayscraper in SU2024

To Enable the Show Loader Snaps flag
Open a Command Prompt
cd C:\Program Files (x86)\Windows Kits\10\Debuggers\x64
gflags -i sketchup.exe +sls

Start windbg.exe
File>Open Executable
Navigate to Sketchup.exe
The debugger will load Sketchup and stop at the entry point
Press F5 to complete loading Sketchup.

At this point you can either enable the Rayscraper extension or
require ‘path/path/SUEX_Rayscraper.so’ in the Ruby Console

The loader failure information will be logged to the windbg console.

Disable the Show Loader Snaps flag
gflags -i sketchup.exe -sls

pixelcruncher · March 31, 2025, 12:44pm

Thanks for the suggestions @sWilliams ! That helps.

Let’s say I use new SU2025 functions (e.g. SU_RESULT SUMaterialGetMetallicTexture(SUMaterialRef material, SUTextureRef* texture)) in my extension. How are these symbols resolved when I run my extension in SU2024 for example?

Thanks,
Thomas

pixelcruncher · March 31, 2025, 2:42pm

I upgraded to the latest SDK (2025-0-575) and still have the same issue. My extension works in SU2025, but when loading in SU2024 I’m getting the following error:

[2025-03-31 15:07:15.523] [error] [16276] Failed to load library 'C:\Users\Thomas\dev\RayscaperBuilds\Release\rayscaper\installed\Windows\3.2.2\0.9.45 Beta\resources\SUEX_Rayscaper.so': [127] The specified procedure could not be found.

Could it be that my plugin is no longer compatible with older versions of SketchUp because I’m using symbols relevant only to the SU2025 (like SUMaterialGetMetallicTexture)?

sWilliams · March 31, 2025, 4:55pm

Please upload an rbz of your failing extension. No need for a license, I just want to watch it load.

DanRathbun · March 31, 2025, 5:27pm

Good question.

I assume that since the SDK is a file SDK and since the 2021 release that SketchUp can open model files from newer version, that it is necessary to code defensively with respect to features that may not be present in the file that is opened with the C API.

So, you have four possible scenarios for the SKP file ↔ SDK version.

The file was created in an older version and lacks the PBR material properties:
- … and is opened in a pre-PBR version of SketchUp.
- … and is opened in a PBR aware version of SketchUp.
The file was created in a newer PBR aware version and possibly contains the PBR material properties:
- … and is opened in a pre-PBR version of SketchUp.
- … and is opened in a PBR aware version of SketchUp.

I think the first check that you need to do is use SUMaterialGetWorkflow() to determine whether the file is even using PBR materials.

(It is a bit weird that this is defined needing a material argument. In Ruby this would be either a method of the model object’s materials collection or an attribute of the model options hash. But this is C. What happens if the model has no materials? Do ya’ need to create one in order to ask if the workflow is set to classic or PBR?)

Anyway, I wonder if an older model is opened, does this set the 2nd argument to the SUMaterialWorkflow_Classic enumeration value or does it return SU_ERROR_NULL_POINTER_OUTPUT?

Then before attempting to get any PBR texture, use the query functions:

Same question when a pre-PBR file is opened or a PBR-aware file is open in a older version, does this set the bool argument returning SU_ERROR_NONE, or does it return SU_ERROR_NULL_POINTER_OUTPUT?

pixelcruncher · March 31, 2025, 6:54pm

Hey @sWilliams,

I appreciate the help!

Here’s a link to my extension’s RBZ: Rayscaper_Win_0.9.45_Beta.rbz - Google Drive. Internally, it packs the DLLs required to run Rayscaper. You will notice that it works in SU2025 but fails in SU2024.

Internally, I use two DLLs:

SUEX_Rayscaper_LoadDlls.so: The purpose of this DLL is to simply load the dependencies of my main DLL, and load the DLL itself. This is to make sure I’m using the correct version of dependencies and don’t fallback to some dll installed on the user’s system.
SUEX_Rayscaper.so: This is my main dll.

I can successfully load the first DLL, but that one fails as soon as I try to load SUEX_Rayscaper.so in SU2024.

pixelcruncher · March 31, 2025, 7:02pm

@DanRathbun Thanks for the explanation!

So I assume that the new SDK provides some stubbing when the code detects that it’s running in a version of SketchUp that doesn’t support a particular API.

I assume that since the SDK is a file SDK and since the 2021 release that SketchUp can
open model files from newer version, that it is necessary to code defensively with respect
to features that may not be present in the file that is opened with the C API.

I’m using the live C API to query things (not modifying anything). So I assume it’s not querying from a file representation of the scene, but from an in-memory data structure representing the scene? But I’m only guessing here.

Anyway, I wonder if an older model is opened, does this set the 2nd argument to the SUMaterialWorkflow_Classic enumeration value or does it return SU_ERROR_NULL_POINTER_OUTPUT?

That’s a good question. I haven’t been able to verify that by running in an older SU version (because see my original issue ). I have coded this defensively, assuming anything that indicates not PBR or an error means classic workflow:

bool UsesSketchUpPbrMaterial(SUMaterialRef su_material) {
  SUMaterialWorkflow workflow = SUMaterialWorkflow::SUMaterialWorkflow_Classic;
  switch (SUMaterialGetWorkflow(su_material, &workflow)) {
    case SU_ERROR_NONE:
      return workflow == SUMaterialWorkflow::SUMaterialWorkflow_PBRMetallicRoughness;
    default:
      return false;
  }
}

Thanks for the help.
Regards,
Thomas

DanRathbun · March 31, 2025, 7:27pm

I do not believe there is a difference to the SDK. I.e., with the “live” API the model is preloaded for you. In standalone mode you must explicitly load the model into memory from a file path.

pixelcruncher · April 13, 2025, 12:56pm

I confirmed that a C extension using the live C-API, compiled using the latest SU 2025 SDK, can be loaded in SU2024 and SU2023, but not in SU2022.(edit: It’s not entirely compatible, as soon as I use environment functions, it fails to load in older SketchUp versions, see my next post).

@tt_su I updated the live C API example to confirm this. I updated the code for Ruby 3.2 and the latest SketchUp APIs. Do you mind reviewing my PR? Upgrade to latest SketchUp SDKs and Ruby version by thomasloockx · Pull Request #9 · SketchUp/sketchup-live-c-api · GitHub

Still trying to figure out why my extension fails to load with the latest SDK in SU2024 and SU2023.

pixelcruncher · April 13, 2025, 1:29pm

@tt_su

It seems that the SU2025 SDK is not fully compatible with older versions.

I updated the example C extension to use the new environments API. I can load this extension fine in the SU2025 but fails in the SU2024 API. This is the same issue I’m seeing with my extension. Note that a new function like SUMaterialGetWorkflow does work in older version of SketchUp.

Example commit (on top of the PR I created in my previous post) that works in SU2025 but fails in SU2024: Add a method that uses the new environments API · SketchUp/sketchup-live-c-api@d4868f1 · GitHub

SU2025

puts "-- SketchUp version: #{Sketchup.version} --"
ext_path = "C:/Users/Thomas/dev/sketchup-live-c-api/cext/ruby_extension/bin/Release"
$LOAD_PATH << ext_path
major, minor, patch = RUBY_VERSION.split('.').map(&:to_i)
require "#{major}.#{minor}/example"
puts Examples::LiveCAPI.get_sdk_version
Examples::LiveCAPI.get_material_descriptions.each { |d| puts d }
Examples::LiveCAPI.get_environment_names.each { |n| puts n }
-- SketchUp version: 25.0.571 --
SketchUp API version: 13.0
Material plastic_01, Workflow: Classic
Material 100cm_Grid_Prisma_Cool_Grey_01, Workflow: Classic
Construction Zone 2K IBL
=> ["Construction Zone 2K IBL"]

SU2024

puts "-- SketchUp version: #{Sketchup.version} --"
ext_path = "C:/Users/Thomas/dev/sketchup-live-c-api/cext/ruby_extension/bin/Release"
$LOAD_PATH << ext_path
major, minor, patch = RUBY_VERSION.split('.').map(&:to_i)
require "#{major}.#{minor}/example"
puts Examples::LiveCAPI.get_sdk_version
Examples::LiveCAPI.get_material_descriptions.each { |d| puts d }
Examples::LiveCAPI.get_environment_names.each { |n| puts n }
-- SketchUp version: 24.0.484 --
Error: #<LoadError: 127: The specified procedure could not be found.   - C:/Users/Thomas/dev/sketchup-live-c-api/cext/ruby_extension/bin/Release/3.2/example.so>
<internal:C:/Program Files/SketchUp/SketchUp 2024/Tools/RubyStdLib/rubygems/core_ext/kernel_require.rb>:85:in `require'
<internal:C:/Program Files/SketchUp/SketchUp 2024/Tools/RubyStdLib/rubygems/core_ext/kernel_require.rb>:85:in `require'
(eval):5:in `<main>'
SketchUp:in `eval'
=> nil

Kudos to @sWilliams to help me track it down to the environment APIs.

DanRathbun · April 13, 2025, 9:37pm

I see you only have two DLLs. I’m not sure what the versions of SketchUp you intend of supporting, but if only Ruby 3.2 and 2.7, then you only go back to SketchUp 2021. (Which was the start of the new file “versionless” format.)

Somewhere I noted (perhaps not in this thread) that this section of the SDK main page does not specifically mention SketchUp 2024 and 2025 releases, re: the toolset.
I think that it implies that SketchUp 2024 and 2025 are built using MSVS 2022 to platform toolset v143.
SketchUp 2020, 2021, 2022, and 2023 built using MSVS 2019 to platform toolset v142.
SketchUp 2017, 2018, and 2019 for Windows were built using MSVS 2015 SP1, to platform toolset v140.
As a tabular reference:

SketchUp Ruby MSVS Toolset

2024, 2025 3.2 2022 v143

2021, 2022, 2023 2.7 2019 v142

2020 2.5 2019 v142

2019 2.5 2015SP1 v140

2017, 2018 2.2 2015SP1 v140
For “Live” use I would think that the correct VC runtime DLLs in SketchUp’s binary directory are those used.

~

Topic		Replies	Views
Update C Plugin to 2024 issue SketchUp SDK	26	980	May 11, 2024
Custom ruby c++ extension: LoadError: 127 on 2017 but not 2018 Developers windows , ruby	3	975	August 16, 2019
Will my plugins be compatible with 2018? Ruby API compatibility	3	1037	July 25, 2018
How to make a C-extension using the C-API compatible with previous SU versions? SketchUp SDK	11	2909	March 29, 2017
Best practice to support multiple SketchUp versions? SketchUp SDK	15	3176	July 30, 2019

SketchUp	Ruby	MSVS	Toolset
2024, 2025	3.2	2022	v143
2021, 2022, 2023	2.7	2019	v142
2020	2.5	2019	v142
2019	2.5	2015SP1	v140
2017, 2018	2.2	2015SP1	v140

SketchUp 2025 C SDK Compatibility

SU2025

SU2024

Related topics