imgui_tex_inspect (C++)

ImGui Tex Inspect: a texture inspector: zoom into a texture down to its pixels, read their values, and draw annotations over them.

imgui_tex_inspect.h¶

INIT & SHUTDOWN¶

ImGuiTexInspect::Init¶

void Init();

ImGuiTexInspect::Shutdown¶

void Shutdown();

BASIC USAGE¶

InspectorAlphaMode (enum)¶

InspectorFlags_ (enum)¶

SizeIncludingBorder (struct)¶

SizeIncludingBorder::SizeIncludingBorder¶

SizeIncludingBorder(ImVec2 size):Size(size);

SizeExcludingBorder (struct)¶

SizeExcludingBorder::SizeExcludingBorder¶

SizeExcludingBorder(ImVec2 size):size(size);

BeginInspectorPanel¶

• Returns True if panel is drawn. Note that flags will only be considered on the first call

ImGuiTexInspect::BeginInspectorPanel¶

bool BeginInspectorPanel(const char *name, ImTextureID, ImVec2 textureSize, InspectorFlags flags = 0);

bool BeginInspectorPanel(const char *name, ImTextureID, ImVec2 textureSize, InspectorFlags flags, SizeIncludingBorder size);

bool BeginInspectorPanel(const char *name, ImTextureID, ImVec2 textureSize, InspectorFlags flags, SizeExcludingBorder size);

ImGuiTexInspect::EndInspectorPanel¶

void EndInspectorPanel();

EndInspectorPanel

• Always call after BeginInspectorPanel and after you have drawn any required annotations

ImGuiTexInspect::ReleaseInspectorData¶

void ReleaseInspectorData(ImGuiID id);

ReleaseInspectorData

• ImGuiTexInspect keeps texture data cached in memory. If you know you won’t

• be displaying a particular panel for a while you can call this to release

• the memory. It won’t be allocated again until next time you call

• BeginInspectorPanel. If id is None then the current (most recent) inspector

• will be affected. Unless you have a lot of different Inspector instances

• you can probably not worry about this. Call CurrentInspector_GetID to get

• the ID of an inspector.

ImGuiTexInspect::CurrentInspector_SetAlphaMode¶

void CurrentInspector_SetAlphaMode(InspectorAlphaMode);

CurrentInspector_SetAlphaMode - see enum comments for details

ImGuiTexInspect::CurrentInspector_SetFlags¶

void CurrentInspector_SetFlags(InspectorFlags toSet, InspectorFlags toClear = 0);

ImGuiTexInspect::CurrentInspector_ClearFlags¶

inline void CurrentInspector_ClearFlags(InspectorFlags toClear);

ImGuiTexInspect::CurrentInspector_SetGridColor¶

void CurrentInspector_SetGridColor(ImU32 color);

ImGuiTexInspect::CurrentInspector_SetMaxAnnotations¶

void CurrentInspector_SetMaxAnnotations(int maxAnnotations);

ImGuiTexInspect::CurrentInspector_InvalidateTextureCache¶

void CurrentInspector_InvalidateTextureCache();

CurrentInspector_InvalidateTextureCache

• If using the InspectorFlags_NoAutoReadTexture flag then call this to

• indicate your texture has changed context.

CurrentInspector_SetCustomBackgroundColor¶

• If using InspectorAlphaMode_CustomColor then this is the color that will be

• blended as the background where alpha is less than one.

ImGuiTexInspect::CurrentInspector_SetCustomBackgroundColor¶

void CurrentInspector_SetCustomBackgroundColor(ImVec4 color);

void CurrentInspector_SetCustomBackgroundColor(ImU32 color);

ImGuiTexInspect::CurrentInspector_GetID¶

ImGuiID CurrentInspector_GetID();

CurrentInspector_GetID

• Get the ID of the current inspector. Currently only used for calling

• ReleaseInspectorData.

ImGuiTexInspect::DrawColorMatrixEditor¶

void DrawColorMatrixEditor();

ColorMatrix editor. See comments on ColorMatrix below.

Some convenience functions for drawing ImGui controls for the current Inspector

ImGuiTexInspect::DrawGridEditor¶

void DrawGridEditor();

Grid editor. Enable/Disable grid. Set Grid Color.

ImGuiTexInspect::DrawColorChannelSelector¶

void DrawColorChannelSelector();

For toggling R,G,B channels

ImGuiTexInspect::DrawAlphaModeSelector¶

void DrawAlphaModeSelector();

A combo box for selecting the alpha mode

ImGuiTexInspect::SetZoomRate¶

void SetZoomRate(float factor);

CONTEXT-WIDE SETTINGS
/* SetZoomRate

• factor should be greater than 1. A value of 1.5 means one mouse wheel

• scroll will increase zoom level by 50%. The factor used for zooming out is

• 1/factor. */

ANNOTATION TOOLS¶

ImGuiTexInspect::DrawAnnotationLine¶

void DrawAnnotationLine(ImDrawList *drawList, ImVec2 fromTexel, ImVec2 toTexel, Transform2D texelsToPixels, ImU32 color);

DrawAnnotationLine

• Convenience function to add a line to draw list using texel coordinates.

ValueText (struct)¶

ValueText

• An annoation class that draws text inside each texel when zoom level is high enough for it to fit.

• The text shows the value of the texel. E.g. “R:255, G: 128, B:0, A:255”

ValueText::Format (enum)¶

ValueText::ValueText¶

ValueText(Format format = HexString);

ValueText::DrawAnnotation¶

void DrawAnnotation(ImDrawList *drawList, ImVec2 texel, Transform2D texelsToPixels, ImVec4 value);

Arrow (struct)¶

Arrow

• An annotation class that draws an arrow inside each texel when zoom level is

• high enough. The direction and length of the arrow are determined by texel

• values.

• The X and Y components of the arrow is determined by the VectorIndex_x, and

• VectorIndex_y channels of the texel value. Examples:

• VectorIndex_x = 0, VectorIndex_y = 1 means X component is red and Y component is green

• VectorIndex_x = 1, VectorIndex_y = 2 means X component is green and Y component is blue

• VectorIndex_x = 0, VectorIndex_y = 3 means X component is red and Y component is alpha\

• ZeroPoint is the texel value which corresponds to a zero length vector. E.g.

• ZeroPoint = (0.5, 0.5) means (0.5, 0.5) will be drawn as a zero length arrow\

• All public properties can be directly manipulated. There are also presets that can be set

• by calling UsePreset.

Arrow::Preset (enum)¶

Arrow::Arrow¶

Arrow(int xVectorIndex = 0, int yVectorIndex = 1, ImVec2 lineScale = ImVec2(1, 1));

right edge of texture. (0,-1) will draw exactly to the bottom etc.

Arrow::UsePreset¶

Arrow &UsePreset(Preset);

Arrow::DrawAnnotation¶

void DrawAnnotation(ImDrawList *drawList, ImVec2 texel, Transform2D texelsToPixels, ImVec4 value);

INTERNAL¶

Transform2D (struct)¶

Transform2D::Inverse¶

Transform2D Inverse() const;

Return an inverse transform such that transform.Inverse() * transform * vector == vector

imgui_tex_inspect_demo.h¶

Texture (struct)¶

ImGuiTexInspect::ShowDemoWindow¶

void ShowDemoWindow();

}