Edit

ID3D10Device::CreateInputLayout method (d3d10.h)

  • Article

Create an input-layout object to describe the input-buffer data for the input-assembler stage.

Syntax

HRESULT CreateInputLayout(
  [in]  const D3D10_INPUT_ELEMENT_DESC *pInputElementDescs,
  [in]  UINT                           NumElements,
  [in]  const void                     *pShaderBytecodeWithInputSignature,
  [in]  SIZE_T                         BytecodeLength,
  [out] ID3D10InputLayout              **ppInputLayout
);

Parameters

[in] pInputElementDescs

Type: const D3D10_INPUT_ELEMENT_DESC*

An array of the input-assembler stage input data types; each type is described by an element description (see D3D10_INPUT_ELEMENT_DESC).

[in] NumElements

Type: UINT

The number of input-data types in the array of input-elements.

[in] pShaderBytecodeWithInputSignature

Type: const void*

A pointer to the compiled shader. To get this pointer see Getting a Pointer to a Compiled Shader. The compiled shader code contains a input signature which is validated against the array of elements. See remarks.

[in] BytecodeLength

Type: SIZE_T

Size of the compiled shader.

[out] ppInputLayout

Type: ID3D10InputLayout**

A pointer to the input-layout object created (see ID3D10InputLayout Interface). To validate the other input parameters, set this pointer to be NULL and verify that the method returns S_FALSE.

Return value

Type: HRESULT

If the method succeeds, the return code is S_OK. See Direct3D 10 Return Codes for failing error codes.

Remarks

After creating an input layout object, it must be bound to the input-assembler stage before calling a draw API. See Getting Started with the Input-Assembler Stage (Direct3D 10) for example code.

Once an input-layout object is created from a shader signature, the input-layout object can be reused with any other shader that has an identical input signature (semantics included). This can simplify the creation of input-layout objects when you are working with many shaders with identical inputs.

If a data type in the input-layout declaration does not match the data type in a shader-input signature, CreateInputLayout will generate a warning during compilation. The warning is simply to call attention to the fact that the data may be reinterpreted when read from a register. You may either disregard this warning (if reinterpretation is intentional) or make the data types match in both declarations to eliminate the warning. The Data Conversion Rules overview describes the rules applied for data type conversion.

Differences between Direct3D 9 and Direct3D 10:

Mapping the vertex data to the shader inputs with an input layout is a new way of doing things in Direct3D 10 that improves performance.

In Direct3D 10 the vertex data is mapped to the shader inputs when the input layout object is created, whereas in Direct3D 9 this mapping was done at Draw time based on the currently bound vertex declarations, vertex buffers, and vertex shaders. Doing this mapping when the input layout object is created reduces or eliminates extra linkage work for drivers at Draw time because this re-mapping is no longer necessary.

Requirements

Requirement Value
Target Platform Windows
Header d3d10.h
Library D3D10.lib

See also

ID3D10Device Interface