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 library itself.

alignForwardLog2

Rounds an address up to the next alignment boundary using log2 representation. Equivalent to alignForward with alignment = 1 << log2_alignment. More efficient when alignment is known to be a power of 2.

mem.alignForwardLog2

pub fn alignForwardLog2(addr: usize, log2_alignment: u8) usize

File

lib/std/mem.zig:4771

Code

pub fn alignForwardLog2(addr: usize, log2_alignment: u8) usize {
    const alignment = @as(usize, 1) << @as(math.Log2Int(usize), @intCast(log2_alignment));
    return alignForward(usize, addr, alignment);
}