Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › zig › llvm › Builder › AddrSpace Public Enum AddrSpace Doc Source Public Enum std.zig.llvm.Builder.AddrSpace
pub const AddrSpace = enum (u24 ) Namespaces Structs Functions File zig/llvm/Builder.zig: 2834
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942 pub const AddrSpace = enum (u24 ) {
default ,
_ ,
// See llvm/lib/Target/X86/X86.h
pub const x86 = struct {
pub const gs : AddrSpace = @fromBackingInt (256 );
pub const fs : AddrSpace = @fromBackingInt (257 );
pub const ss : AddrSpace = @fromBackingInt (258 );
pub const ptr32_sptr : AddrSpace = @fromBackingInt (270 );
pub const ptr32_uptr : AddrSpace = @fromBackingInt (271 );
pub const ptr64 : AddrSpace = @fromBackingInt (272 );
};
pub const x86_64 = x86 ;
// See llvm/lib/Target/AVR/AVR.h
pub const avr = struct {
pub const data : AddrSpace = @fromBackingInt (0 );
pub const program : AddrSpace = @fromBackingInt (1 );
pub const program1 : AddrSpace = @fromBackingInt (2 );
pub const program2 : AddrSpace = @fromBackingInt (3 );
pub const program3 : AddrSpace = @fromBackingInt (4 );
pub const program4 : AddrSpace = @fromBackingInt (5 );
pub const program5 : AddrSpace = @fromBackingInt (6 );
};
// See llvm/lib/Target/NVPTX/NVPTX.h
pub const nvptx = struct {
pub const generic : AddrSpace = @fromBackingInt (0 );
pub const global : AddrSpace = @fromBackingInt (1 );
pub const constant : AddrSpace = @fromBackingInt (2 );
pub const shared : AddrSpace = @fromBackingInt (3 );
pub const param : AddrSpace = @fromBackingInt (4 );
pub const local : AddrSpace = @fromBackingInt (5 );
};
// See llvm/lib/Target/AMDGPU/AMDGPU.h
pub const amdgpu = struct {
pub const flat : AddrSpace = @fromBackingInt (0 );
pub const global : AddrSpace = @fromBackingInt (1 );
pub const region : AddrSpace = @fromBackingInt (2 );
pub const local : AddrSpace = @fromBackingInt (3 );
pub const constant : AddrSpace = @fromBackingInt (4 );
pub const private : AddrSpace = @fromBackingInt (5 );
pub const constant_32bit : AddrSpace = @fromBackingInt (6 );
pub const buffer_fat_pointer : AddrSpace = @fromBackingInt (7 );
pub const buffer_resource : AddrSpace = @fromBackingInt (8 );
pub const buffer_strided_pointer : AddrSpace = @fromBackingInt (9 );
pub const param_d : AddrSpace = @fromBackingInt (6 );
pub const param_i : AddrSpace = @fromBackingInt (7 );
pub const constant_buffer_0 : AddrSpace = @fromBackingInt (8 );
pub const constant_buffer_1 : AddrSpace = @fromBackingInt (9 );
pub const constant_buffer_2 : AddrSpace = @fromBackingInt (10 );
pub const constant_buffer_3 : AddrSpace = @fromBackingInt (11 );
pub const constant_buffer_4 : AddrSpace = @fromBackingInt (12 );
pub const constant_buffer_5 : AddrSpace = @fromBackingInt (13 );
pub const constant_buffer_6 : AddrSpace = @fromBackingInt (14 );
pub const constant_buffer_7 : AddrSpace = @fromBackingInt (15 );
pub const constant_buffer_8 : AddrSpace = @fromBackingInt (16 );
pub const constant_buffer_9 : AddrSpace = @fromBackingInt (17 );
pub const constant_buffer_10 : AddrSpace = @fromBackingInt (18 );
pub const constant_buffer_11 : AddrSpace = @fromBackingInt (19 );
pub const constant_buffer_12 : AddrSpace = @fromBackingInt (20 );
pub const constant_buffer_13 : AddrSpace = @fromBackingInt (21 );
pub const constant_buffer_14 : AddrSpace = @fromBackingInt (22 );
pub const constant_buffer_15 : AddrSpace = @fromBackingInt (23 );
pub const streamout_register : AddrSpace = @fromBackingInt (128 );
};
pub const spirv = struct {
pub const function : AddrSpace = @fromBackingInt (0 );
pub const cross_workgroup : AddrSpace = @fromBackingInt (1 );
pub const uniform_constant : AddrSpace = @fromBackingInt (2 );
pub const workgroup : AddrSpace = @fromBackingInt (3 );
pub const generic : AddrSpace = @fromBackingInt (4 );
pub const device_only_intel : AddrSpace = @fromBackingInt (5 );
pub const host_only_intel : AddrSpace = @fromBackingInt (6 );
pub const input : AddrSpace = @fromBackingInt (7 );
};
// See llvm/include/llvm/CodeGen/WasmAddressSpaces.h
pub const wasm = struct {
pub const default : AddrSpace = @fromBackingInt (0 );
pub const variable : AddrSpace = @fromBackingInt (1 );
pub const externref : AddrSpace = @fromBackingInt (10 );
pub const funcref : AddrSpace = @fromBackingInt (20 );
};
pub fn format (addr_space : AddrSpace , w : *Writer ) Writer .Error !void {
return Prefixed .format (.{ .addr_space = addr_space , .prefix = "" }, w );
}
pub const Prefixed = struct {
addr_space : AddrSpace ,
prefix : []const u8 ,
pub fn format (p : Prefixed , w : *Writer ) Writer .Error !void {
switch (p .addr_space ) {
.default => return ,
else => return w .print ("{s}addrspace({d})" , .{ p .prefix , p .addr_space }),
}
}
};
pub fn fmt (addr_space : AddrSpace , prefix : []const u8 ) Prefixed {
return .{ .addr_space = addr_space , .prefix = prefix };
}
}