Fix javadoc
This commit is contained in:
1 parent
42262e1a68
commit
162c1cd0dd
9 files changed
+22
-22
No files matched your search
@@ -54,14 +54,14 @@ public final class ImFont implements ImDestroyable {
|
|||||||
// TODO IndexAdvanceX
|
// TODO IndexAdvanceX
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* = FallbackGlyph->AdvanceX
|
* = FallbackGlyph.AdvanceX
|
||||||
*/
|
*/
|
||||||
public native float getFallbackAdvanceX(); /*
|
public native float getFallbackAdvanceX(); /*
|
||||||
return IM_FONT->FallbackAdvanceX;
|
return IM_FONT->FallbackAdvanceX;
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* = FallbackGlyph->AdvanceX
|
* = FallbackGlyph.AdvanceX
|
||||||
*/
|
*/
|
||||||
public native void setFallbackAdvanceX(float fallbackAdvanceX); /*
|
public native void setFallbackAdvanceX(float fallbackAdvanceX); /*
|
||||||
IM_FONT->FallbackAdvanceX = fallbackAdvanceX;
|
IM_FONT->FallbackAdvanceX = fallbackAdvanceX;
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ import java.nio.ByteOrder;
|
|||||||
* - If you pass a 'glyph_ranges' array to AddFont*** functions, you need to make sure that your array persist up until the
|
* - If you pass a 'glyph_ranges' array to AddFont*** functions, you need to make sure that your array persist up until the
|
||||||
* atlas is build (when calling GetTexData*** or Build()). We only copy the pointer, not the data.
|
* atlas is build (when calling GetTexData*** or Build()). We only copy the pointer, not the data.
|
||||||
* - Important: By default, AddFontFromMemoryTTF() takes ownership of the data. Even though we are not writing to it, we will free the pointer on destruction.
|
* - Important: By default, AddFontFromMemoryTTF() takes ownership of the data. Even though we are not writing to it, we will free the pointer on destruction.
|
||||||
* You can set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed,
|
* You can set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed,
|
||||||
* - Even though many functions are suffixed with "TTF", OTF data is supported just as well.
|
* - Even though many functions are suffixed with "TTF", OTF data is supported just as well.
|
||||||
* - This is an old API and it is currently awkward for those and and various other reasons! We will address them in the future!
|
* - This is an old API and it is currently awkward for those and and various other reasons! We will address them in the future!
|
||||||
*/
|
*/
|
||||||
@@ -124,7 +124,7 @@ public final class ImFontAtlas implements ImDestroyable {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
|
* Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
|
||||||
* Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
|
* Set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
|
||||||
*/
|
*/
|
||||||
public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels) {
|
public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels) {
|
||||||
return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels));
|
return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels));
|
||||||
@@ -137,7 +137,7 @@ public final class ImFontAtlas implements ImDestroyable {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
|
* Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
|
||||||
* Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
|
* Set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
|
||||||
*/
|
*/
|
||||||
public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels, final ImFontConfig imFontConfig) {
|
public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels, final ImFontConfig imFontConfig) {
|
||||||
return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels, imFontConfig.ptr));
|
return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels, imFontConfig.ptr));
|
||||||
@@ -149,7 +149,7 @@ public final class ImFontAtlas implements ImDestroyable {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
|
* Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
|
||||||
* Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
|
* Set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
|
||||||
*/
|
*/
|
||||||
public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels, final short[] glyphRanges) {
|
public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels, final short[] glyphRanges) {
|
||||||
return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels, glyphRanges));
|
return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels, glyphRanges));
|
||||||
@@ -161,7 +161,7 @@ public final class ImFontAtlas implements ImDestroyable {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
|
* Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
|
||||||
* Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
|
* Set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
|
||||||
*/
|
*/
|
||||||
public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels, final ImFontConfig imFontConfig, final short[] glyphRanges) {
|
public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels, final ImFontConfig imFontConfig, final short[] glyphRanges) {
|
||||||
return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels, imFontConfig.ptr, glyphRanges));
|
return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels, imFontConfig.ptr, glyphRanges));
|
||||||
@@ -445,14 +445,14 @@ public final class ImFontAtlas implements ImDestroyable {
|
|||||||
// Read docs/FONTS.txt for more details about using colorful icons.
|
// Read docs/FONTS.txt for more details about using colorful icons.
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Id needs to be >= 0x110000. Id >= 0x80000000 are reserved for ImGui and ImDrawList
|
* Id needs to be {@code >=} 0x110000. Id {@code >=} 0x80000000 are reserved for ImGui and ImDrawList
|
||||||
*/
|
*/
|
||||||
public native int addCustomRectRegular(int id, int width, int height); /*
|
public native int addCustomRectRegular(int id, int width, int height); /*
|
||||||
return IM_FONT_ATLAS->AddCustomRectRegular((unsigned int)id, width, height);
|
return IM_FONT_ATLAS->AddCustomRectRegular((unsigned int)id, width, height);
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Id needs to be < 0x110000 to register a rectangle to map into a specific font.
|
* Id needs to be {@code <} 0x110000 to register a rectangle to map into a specific font.
|
||||||
*/
|
*/
|
||||||
public int addCustomRectFontGlyph(final ImFont imFont, final short id, final int width, final int height, final float advanceX) {
|
public int addCustomRectFontGlyph(final ImFont imFont, final short id, final int width, final int height, final float advanceX) {
|
||||||
return nAddCustomRectFontGlyph(imFont.ptr, id, width, height, advanceX);
|
return nAddCustomRectFontGlyph(imFont.ptr, id, width, height, advanceX);
|
||||||
@@ -463,7 +463,7 @@ public final class ImFontAtlas implements ImDestroyable {
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Id needs to be < 0x110000 to register a rectangle to map into a specific font.
|
* Id needs to be {@code <} 0x110000 to register a rectangle to map into a specific font.
|
||||||
*/
|
*/
|
||||||
public int addCustomRectFontGlyph(final ImFont imFont, final short id, final int width, final int height, final float advanceX, final float offsetX, final float offsetY) {
|
public int addCustomRectFontGlyph(final ImFont imFont, final short id, final int width, final int height, final float advanceX, final float offsetX, final float offsetY) {
|
||||||
return nAddCustomRectFontGlyph(imFont.ptr, id, width, height, advanceX, offsetX, offsetY);
|
return nAddCustomRectFontGlyph(imFont.ptr, id, width, height, advanceX, offsetX, offsetY);
|
||||||
|
|||||||
@@ -284,14 +284,14 @@ public final class ImFontConfig implements ImDestroyable {
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable.
|
* Brighten ({@code >}1.0f) or darken ({@code <}1.0f) font output. Brightening small fonts may be a good workaround to make them more readable.
|
||||||
*/
|
*/
|
||||||
public native float getRasterizerMultiply(); /*
|
public native float getRasterizerMultiply(); /*
|
||||||
return IM_FONT_CONFIG->RasterizerMultiply;
|
return IM_FONT_CONFIG->RasterizerMultiply;
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable.
|
* Brighten ({@code >}1.0f) or darken ({@code <}1.0f) font output. Brightening small fonts may be a good workaround to make them more readable.
|
||||||
*/
|
*/
|
||||||
public native void setRasterizerMultiply(float rasterizerMultiply); /*
|
public native void setRasterizerMultiply(float rasterizerMultiply); /*
|
||||||
IM_FONT_CONFIG->RasterizerMultiply = rasterizerMultiply;
|
IM_FONT_CONFIG->RasterizerMultiply = rasterizerMultiply;
|
||||||
|
|||||||
@@ -313,7 +313,7 @@ public final class ImGuiIO {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Enable resizing of windows from their edges and from the lower-left corner.
|
* Enable resizing of windows from their edges and from the lower-left corner.
|
||||||
* This requires (io.BackendFlags & ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback.
|
* This requires (io.BackendFlags {@code &} ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback.
|
||||||
* (This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag)
|
* (This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag)
|
||||||
*/
|
*/
|
||||||
public native boolean getConfigWindowsResizeFromEdges(); /*
|
public native boolean getConfigWindowsResizeFromEdges(); /*
|
||||||
@@ -322,7 +322,7 @@ public final class ImGuiIO {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Enable resizing of windows from their edges and from the lower-left corner.
|
* Enable resizing of windows from their edges and from the lower-left corner.
|
||||||
* This requires (io.BackendFlags & ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback.
|
* This requires (io.BackendFlags {@code &} ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback.
|
||||||
* (This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag)
|
* (This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag)
|
||||||
*/
|
*/
|
||||||
public native void setConfigWindowsResizeFromEdges(boolean configWindowsResizeFromEdges); /*
|
public native void setConfigWindowsResizeFromEdges(boolean configWindowsResizeFromEdges); /*
|
||||||
|
|||||||
@@ -312,14 +312,14 @@ public final class ImGuiStyle implements ImDestroyable {
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1).
|
* Minimum horizontal spacing between two columns. Preferably {@code >} (FramePadding.x + 1).
|
||||||
*/
|
*/
|
||||||
public native float getColumnsMinSpacing(); /*
|
public native float getColumnsMinSpacing(); /*
|
||||||
return IMGUI_STYLE->ColumnsMinSpacing;
|
return IMGUI_STYLE->ColumnsMinSpacing;
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1).
|
* Minimum horizontal spacing between two columns. Preferably {@code >} (FramePadding.x + 1).
|
||||||
*/
|
*/
|
||||||
public native void setColumnsMinSpacing(float columnsMinSpacing); /*
|
public native void setColumnsMinSpacing(float columnsMinSpacing); /*
|
||||||
IMGUI_STYLE->ColumnsMinSpacing = columnsMinSpacing;
|
IMGUI_STYLE->ColumnsMinSpacing = columnsMinSpacing;
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ public final class ImDrawListFlags {
|
|||||||
*/
|
*/
|
||||||
public static final int AntiAliasedFill = 1 << 1;
|
public static final int AntiAliasedFill = 1 << 1;
|
||||||
/**
|
/**
|
||||||
* Can emit 'VtxOffset > 0' to allow large meshes. Set when 'ImGuiBackendFlags_RendererHasVtxOffset' is enabled.
|
* Can emit 'VtxOffset {@code >} 0' to allow large meshes. Set when 'ImGuiBackendFlags_RendererHasVtxOffset' is enabled.
|
||||||
*/
|
*/
|
||||||
public static final int AllowVtxOffset = 1 << 2;
|
public static final int AllowVtxOffset = 1 << 2;
|
||||||
}
|
}
|
||||||
@@ -22,7 +22,7 @@ public final class ImGuiTabBarFlags {
|
|||||||
public static final int TabListPopupButton = 1 << 2;
|
public static final int TabListPopupButton = 1 << 2;
|
||||||
/**
|
/**
|
||||||
* Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button.
|
* Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button.
|
||||||
* You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false.
|
* You can still repro this behavior on user's side with if (IsItemHovered() {@code &&} IsMouseClicked(2)) *p_open = false.
|
||||||
*/
|
*/
|
||||||
public static final int NoCloseWithMiddleMouseButton = 1 << 3;
|
public static final int NoCloseWithMiddleMouseButton = 1 << 3;
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -19,11 +19,11 @@ public final class ImGuiTabItemFlags {
|
|||||||
public static final int SetSelected = 1 << 1;
|
public static final int SetSelected = 1 << 1;
|
||||||
/**
|
/**
|
||||||
* Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button.
|
* Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button.
|
||||||
* You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false.
|
* You can still repro this behavior on user's side with if (IsItemHovered() {@code &&} IsMouseClicked(2)) *p_open = false.
|
||||||
*/
|
*/
|
||||||
public static final int NoCloseWithMiddleMouseButton = 1 << 2;
|
public static final int NoCloseWithMiddleMouseButton = 1 << 2;
|
||||||
/**
|
/**
|
||||||
* Don't call PushID(tab->ID)/PopID() on BeginTabItem()/EndTabItem()
|
* Don't call PushID(tab.ID)/PopID() on BeginTabItem()/EndTabItem()
|
||||||
*/
|
*/
|
||||||
public static final int NoPushId = 1 << 3;
|
public static final int NoPushId = 1 << 3;
|
||||||
}
|
}
|
||||||
@@ -62,11 +62,11 @@ public final class ImGuiWindowFlags {
|
|||||||
*/
|
*/
|
||||||
public static final int NoBringToFrontOnFocus = 1 << 13;
|
public static final int NoBringToFrontOnFocus = 1 << 13;
|
||||||
/**
|
/**
|
||||||
* Always show vertical scrollbar (even if ContentSize.y < Size.y)
|
* Always show vertical scrollbar (even if ContentSize.y {@code <} Size.y)
|
||||||
*/
|
*/
|
||||||
public static final int AlwaysVerticalScrollbar = 1 << 14;
|
public static final int AlwaysVerticalScrollbar = 1 << 14;
|
||||||
/**
|
/**
|
||||||
* Always show horizontal scrollbar (even if ContentSize.x < Size.x)
|
* Always show horizontal scrollbar (even if ContentSize.x {@code <} Size.x)
|
||||||
*/
|
*/
|
||||||
public static final int AlwaysHorizontalScrollbar = 1 << 15;
|
public static final int AlwaysHorizontalScrollbar = 1 << 15;
|
||||||
/**
|
/**
|
||||||
|
|||||||
Reference in new issue
Block a user