Creating an ImageWrapper

• You should use some kind of reference type that manages the memory. std::shared_ptr<ImageWrapper> is my recommendation.
• The ImageWrapper is a resource managing class. This means that you have to keep this object “alive” as long as you want to use the image. When the object goes out of scope \ gets destructed it cleans up the resource it manages.
• Stick to std::shared_ptr and you almost can’t mess up.
• See all ImageWrapper functions here

0. Add the declaration to your .h

   1	std::shared_ptr<ImageWrapper> myImage;

1. Use the constructor with the second or third argument true (or both). This can cause stuttering based on the size of the image. This is best done in your plugin’s onLoad. You only need to load the image once, and onLoad is expected to be a bit stuttery already

   1 2	// ImageWrapper(std::string path, bool canvasLoad = false, bool ImGuiLoad = false); myImage = std::make_shared<ImageWrapper>(gameWrapper->GetDataFolder() / "MyPluginFolder" / "MyImage.png", true, true);

2. Load the resource if you didn’t use the optional args. This also causes lag so it’s best to do this in onLoad or in a place that isn’t called often

   1 2	myImage->LoadForCanvas(); myImage->LoadForImGui();

3. a. Pass it to the canvas wrapper in a drawable callback after ensuring it’s loaded

   1 2 3 4

   if (myImage->IsLoadedForCanvas()) { canvas.DrawTexture(myImage.get(), 1); // there are multiple functions in the canvaswrapper that accept ImageWrapper* }

   b. Use it in your imgui render code. Again checking that it’s loaded

   1 2 3 4

   if (myImage->IsLoadedForImGui() && auto pTex = myImage->GetImguiTex()) { auto rect = myImage->GetSizeF(); ImGui::Image(pTex, { rect.width, rect.height }); }

PS: The backend will load in the resource whenever you try to use the images if it hasn’t already been loaded. So you actually don’t have to worry about it, but the loading can cause some lag\stutters. So it’s better to do it during loading the plugin - when such behaviour can be expected.