Search code examples
c#filteringbit-shift

C# Left Shift Operator


There's a statement a co-worker of mine wrote which I don't completely understand. Unfortunately he's not available right now, so here it is (with modified names, we're working on a game in Unity).

private readonly int FRUIT_LAYERS =
          (1 << LayerMask.NameToLayer("Apple"))
        | (1 << LayerMask.NameToLayer("Banana"));

NameToLayer takes a string and returns an integer. I've always seen left shift operators used with the constant integer on the right side, not the left, and all the examples I'm finding via Google follow that approach. In this case, I think he's pushing Apple and Banana onto the same relative layer (which I'll use later for filtering). In the future there would be more "fruits" to filter by. Any brilliant stackoverflowers who can give me an explanation of what's happening on those lines?


Solution

  • Your coworker is essentially using an int in place of a bool[32] to try to save on space. The block of code you show is analogous to

    bool[] FRUIT_LAYERS = new bool[32];
    FRUIT_LAYERS[LayerMask.NameToLayer("Apple")] = true;
    FRUIT_LAYERS[LayerMask.NameToLayer("Banana")] = true;
    

    You might want to consider a pattern more like this:

    [Flags]
    enum FruitLayers : int
    {
        Apple = 1 << 0,
        Banana = 1 << 1,
        Kiwi = 1 << 2,
        ...
    }
    
    private readonly FruitLayers FRUIT_LAYERS = FruitLayers.Apple | FruitLayers.Banana;