---
title: "ClikaRT::nn::PixelShuffleOptions"
sidebar_label: "PixelShuffleOptions"
description: "Settings of PixelShuffle: chain the setters, or assign the fields."
---

<!-- Generated by tools/doxygen2mdx from Doxygen XML. Do not edit. -->

<span class="api-kind api-kind--struct">struct</span>

**Header:** `ClikaRT/nn/generated/pixelshuffle.h`

Settings of [`PixelShuffle`](./PixelShuffle.md): chain the setters, or assign the fields.

## Member functions

### PixelShuffleOptions() {#PixelShuffleOptions}

<div class="api-signature">

**`PixelShuffleOptions`**(`std::int64_t` `upscale_factor`)

</div>

`PixelShuffleOptions(upscale_factor)`: implicit, so `PixelShuffle(upscale_factor)` reads like the function call.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pixelshuffle.h`, line 36

</div>

### upscale\_factor(int64\_t) {#upscale_factor}

<div class="api-signature">

[`PixelShuffleOptions`](./PixelShuffleOptions.md)`&` **`upscale_factor`**(`std::int64_t` `v`)

</div>

Sets [`upscale_factor`](./PixelShuffleOptions.md#upscale_factor), the factor `r`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pixelshuffle.h`, line 39

</div>

### upscale\_factor() {#upscale_factor-2}

<div class="api-signature">

`std::int64_t` **`upscale_factor`**() `const`

</div>

Reads [`upscale_factor`](./PixelShuffleOptions.md#upscale_factor).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pixelshuffle.h`, line 41

</div>

### mode(ops::PixelShuffleMode) {#mode}

<div class="api-signature">

[`PixelShuffleOptions`](./PixelShuffleOptions.md)`&` **`mode`**([`ops::PixelShuffleMode`](../ops/index.md#PixelShuffleMode) `v`)

</div>

Sets [`mode`](./PixelShuffleOptions.md#mode), the channel ordering of the packed input.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pixelshuffle.h`, line 46

</div>

### mode() {#mode-2}

<div class="api-signature">

[`ops::PixelShuffleMode`](../ops/index.md#PixelShuffleMode) **`mode`**() `const`

</div>

Reads [`mode`](./PixelShuffleOptions.md#mode).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pixelshuffle.h`, line 48

</div>

## Data members

### upscale\_factor\_ {#upscale_factor_}

<div class="api-signature">

`std::int64_t` **`upscale_factor_`**

</div>

The factor `r`. Required: set through the constructor.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pixelshuffle.h`, line 43

</div>

### mode\_ {#mode_}

<div class="api-signature">

[`ops::PixelShuffleMode`](../ops/index.md#PixelShuffleMode) **`mode_`** `=` [`ops::PixelShuffleMode::CRD`](../ops/index.md#PixelShuffleMode)

</div>

The channel ordering of the packed input. Default [`ops::PixelShuffleMode::CRD`](../ops/index.md#PixelShuffleMode).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pixelshuffle.h`, line 51

</div>