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 › WipFunction › shuffleVector Public Function shuffleVector Doc Source Public Function std.zig.llvm.Builder.WipFunction.shuffleVector
pub fn shuffleVector (
self : *WipFunction ,
lhs : Value ,
rhs : Value ,
mask : Value ,
name : []const u8 ,
) Allocator .Error !Value Params File zig/llvm/Builder.zig: 6691
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711 pub fn shuffleVector (
self : *WipFunction ,
lhs : Value ,
rhs : Value ,
mask : Value ,
name : []const u8 ,
) Allocator .Error !Value {
assert (lhs .typeOfWip (self ).isVector (self .builder ));
assert (lhs .typeOfWip (self ) == rhs .typeOfWip (self ));
assert (mask .typeOfWip (self ).scalarType (self .builder ).isInteger (self .builder ));
_ = try self .ensureUnusedExtraCapacity (1 , Instruction .ShuffleVector , 0 );
const instruction = try self .addInst (name , .{
.tag = .shufflevector ,
.data = self .addExtraAssumeCapacity (Instruction .ShuffleVector {
.lhs = lhs ,
.rhs = rhs ,
.mask = mask ,
}),
});
return instruction .toValue ();
}