# computeBufferLayout

A compute buffer layout record carrying name, dtype, elementBytes, alignmentBytes, strideBytes, and related state.

Last updated: 2026-09-09

Package: compute.buffer | Status: source-declared

Tags: buffer, compute, compute.buffer, cpu, method, source-example, thing, yeho

Describe compute buffer layouts, ownership, transfers, and validation.

```yh
external thing computeBufferLayout
```

- text name: Stores name as text.
- text dtype: Stores dtype as text.
- int elementBytes: Stores element bytes as int.
- int alignmentBytes: Stores alignment bytes as int.
- int strideBytes: Stores stride bytes as int.
- text ownership: Stores ownership as text.
- text notes: Stores notes as text.
- computeBufferLayout(text name, text dtype, int elementBytes, int alignmentBytes, int strideBytes, text ownership, text notes): Compute buffer layout.
- IsPacked() returns bool: Is packed.
- IsAligned() returns bool: Is aligned.
- Describe() returns text: Describe.

## Use computeBufferLayout

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

Verification: type checked

```yh
using compute.buffer

// Describe compute buffer layouts, ownership, transfers, and validation.
computeBufferLayout sample = computeBufferLayout("Nova", "int", 4, 4, 4, "host-buffer", "notes")
Console.Log(Text.From(sample.name))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.compute_buffer__computebufferlayout"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "compute.buffer"
version = "0.1.0"
path = "../../../yeho/packages/compute/buffer"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/compute.buffer--computeBufferLayout/usage --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## computeBufferLayout.IsPacked

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using compute.buffer

// Is packed.
computeBufferLayout instance = computeBufferLayout("Nova", "int", 4, 4, 4, "host-buffer", "notes")
bool result = instance.IsPacked()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.compute_buffer__computebufferlayout"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "compute.buffer"
version = "0.1.0"
path = "../../../yeho/packages/compute/buffer"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/compute.buffer--computeBufferLayout/method-IsPacked-8 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## computeBufferLayout.IsAligned

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using compute.buffer

// Is aligned.
computeBufferLayout instance = computeBufferLayout("Nova", "int", 4, 4, 4, "host-buffer", "notes")
bool result = instance.IsAligned()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.compute_buffer__computebufferlayout"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "compute.buffer"
version = "0.1.0"
path = "../../../yeho/packages/compute/buffer"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/compute.buffer--computeBufferLayout/method-IsAligned-9 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## computeBufferLayout.Describe

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using compute.buffer

// Describe.
computeBufferLayout instance = computeBufferLayout("Nova", "int", 4, 4, 4, "host-buffer", "notes")
text result = instance.Describe()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.compute_buffer__computebufferlayout"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "compute.buffer"
version = "0.1.0"
path = "../../../yeho/packages/compute/buffer"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/compute.buffer--computeBufferLayout/method-Describe-10 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup.

Source: yeho/packages/compute/buffer/buffer.yh

AI training permission: https://demonhunterlabs.com/ai-use